All In DMS API (0.129.5)

Download OpenAPI specification:

Contact our support: help+calvium-arts-council-dms-issues@support.calvium.com URL: https://calvium.com/

All In DMS API

Introduction

With the All In DMS REST API you can manage and change Account, Organisation and Event resources programmatically, using HTTP. The API gives you simple access to the functionality. You can use this access to create and manage the resources.

API Error Response codes

Response Code	Description
Authentication
10001	username and password combination is incorrect
10002	format of request body is invalid
10003	unexpected error from auth provider
10004	unexpected auth provider error or database connection error
10005	bearer token has been successfully invalidated
10006	refresh token body incorrect
10007	invalid token, user session cannot be renewed
10008	email address is already in use
10009	invalid email address
10010	invalid signup data
10011	password does not meet security requirements
10012	signup is currently disabled
10013	refresh token has been revoked
10014	session containing the refresh token not found
Files
11001	file not found error
11002	file upload error
User
12001	User not found
12002	user not confirmed
12003	user is banned
12004	user is disabled
12005	user member profile not found
12006	user member profile format incorrect
12007	user member profile already exists for user
12008	user member profile provision format incorrect
12009	user member profile evidence format incorrect
12010	user member provision not found
12011	user provision evidence not found
Authorisation
13001	Invalid roles for action
13002	subscription expired
13003	subscription not found
13004	subscription max locations reached
13005	subscription tier has no access to feature
13006	subscription tier for pilot orgs only
13007	invoice creation failed
13008	subscription product not found
13009	location product not found
13010	invoice not found
13011	invoice does not belong to organisation
Standards
14001	Standard not found
14002	Standard not active
14003	Standard is not used in locations
Organisation
15001	organisation not found
15002	invalid organisation format
15003	invalid organisation user format
15004	organisation user not found
15005	user is in organisation
15006	user must be an organisation admin
15007	user cannot change another user's role
15008	organisation not found for user
15009	requested invite has been cancelled
15010	cultural organization not found
15011	location not found
15012	user has accepted invite
15013	requested invite is not for requested organisation
15014	requested invite is not for requested user
15015	requested invite has been rejected
15016	provider configuration for organisation not found
15017	provider configuration incorrect
15018	event format incorrect
15019	event instance format incorrect
15020	zone not found
15021	invalid zone format
15022	invalid location format
15023	mapping not found
15024	invalid cultural profile format
15025	invite not found
15026	support organization not found
15027	invalid support profile format
15028	organisation group not found for user
15029	invite for organisation group error
15030	proxy organization not found
15031	invalid proxy profile format.
15032	organisation data validation failed for approval
15033	organisation has not been approved
Events
16001	event not found
16002	event instance not found
General
99001	unspecific error
99002	parameter is the incorrect format
99003	paging parameters are incorrect
99004	request body has incorrect values or format

Invited user status descriptions

Status	Description
Invited	User has been invited to join an organisation
Accepted	User has accepted the invitation
Rejected	User has rejected the invitation

Subscription tier descriptions

Value	Description
Tier1	All in Taster account
Tier2	All in Essentials
Tier3	All in Plus

Emails

Emails will be stored in the system as lowercase, both for users and organisations.

JavaScript Examples

Creating a session

const sessionReq = new Request("https://base-url/v1/auth/login", {
  method: "POST",
  body: JSON.stringify({ email: "user@eg.net", password: "***" }),
  headers: { "Content-Type": "application/json" },
});
const createRes = await fetch(sessionReq);
const jsonResponse = createRes.json();
const jwt = res.access_token;

Cancelling a session

const sessionReq = new Request("https://base-url/v1/auth/logout", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorisation: "Bearer " + jwt,
  },
});

Requesting a resource

const sessionReq = new Request("https://base-url/v3/helloworld", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorisation: "Bearer " + jwt,
  },
});

const createRes = await fetch(sessionReq);
const jsonResponse = createRes.json();

Signing up a new account

const sessionReq = new Request("https://base-url/v1/auth/signup", {
  method: "POST",
  body: JSON.stringify({
    name: "full name",
    email: "user@eg.net",
    password: "***",
    confirmPassword: "***",
  }),
  headers: { "Content-Type": "application/json" },
});
const createRes = await fetch(sessionReq);
const userData = createRes.json();
// User awaits for an email to confirm account

Authentication

Forgot password

Send a request to reset password. The user will receive an email.

Request Body schema: application/json
required

credentials object

required

string

email address for user

Responses

Request samples

Payload

Content type

application/json

{"email": "user@theatre.net.uk"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Authenticate user

Use credentials to request a session token

Request Body schema: application/json
required

credentials object

email required	string email address for user
password required	string password for user

Responses

Request samples

Payload

Content type

application/json

{"email": "user@theatre.net.uk",
"password": "***"
}

Response samples

Content type

application/json

{"data": {"user": {"id": "29d6739e-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk"
},
"session": {"acees_token": "eyJhbGciOiJIUzI1NiIsImtpZCI6Ik9Ma2xXVGRYVURYanNza0kiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJo...",
"token_type": "bearer",
"expires_in": 3600,
"expires_at": 1734096290,
"refresh_token": "h-enkJrn3JL3Xmln7cv9mA"
}
}
}

Log out user and invalidate session

Use session bearer token to invalidate a user session

Authorizations:

bearerAuth

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Resend sign up email

Use email to resend an email to confirm details.

Request Body schema: application/json
required

credentials object

required

string

email address for user

Responses

Request samples

Payload

Content type

application/json

{"email": "user@theatre.net.uk"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Provision a user

Use email and password to create a new user. The new user will receive an email to confirm details.

Request Body schema: application/json
required

credentials object

firstName required	string First name for user
lastNme	string First name for user
email required	string email address for user
password required	string password for user
confirmPassword required	string confirmed matching password for user
marketingCommunications required	boolean opt-in to marketing emails
trainingCommunications required	boolean opt-in to training emails

Responses

Request samples

Payload

Content type

application/json

{"firstName": "First Name",
"lastName": "Last Name",
"email": "user@theatre.net.uk",
"password": "***",
"confirmPassword": "***",
"marketingCommunications": true,
"trainingCommunications": true
}

Response samples

Content type

application/json

{"data": {"user": {"id": "29d6739e-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"confirmation_sent_at": "2024-12-13T14:10:52.768187228Z",
"user_metadata": {"email": "user123@example.net.uk",
"email_verified": false
}
}
}
}

Renew user session

Use the refresh token to renew the current session

Request Body schema: application/json
required

credentials object

refresh_token

required

string

refresh token associated with the session

Responses

Request samples

Payload

Content type

application/json

{"refresh_token": "***"
}

Response samples

Content type

application/json

{"data": {"user": {"id": "29d6739e-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk"
},
"session": {"acees_token": "eyJhbGciOiJIUzI1NiIsImtpZCI6Ik9Ma2xXVGRYVURYanNza0kiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJo...",
"token_type": "bearer",
"expires_in": 3600,
"expires_at": 1734096290,
"refresh_token": "h-enkJrn3JL3Xmln7cv9mA"
}
}
}

Verify user magic link token

Use this endpoint to verify a user in the system and get a session token. Or to get a new session token from a reset password link.

Request Body schema: application/json
required

credentials object

token_hash required	string token hash from the magic link or reset password link
type required	string Enum: "email" "recovery" type of token, either 'email' or 'recovery'

Responses

Request samples

Payload

Content type

application/json

{"token_hash": "***",
"type": "email",
"next": "https://example.com/redirect"
}

Response samples

Content type

application/json

{"data": {"user": {"id": "29d6739e-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk"
},
"session": {"acees_token": "eyJhbGciOiJIUzI1NiIsImtpZCI6Ik9Ma2xXVGRYVURYanNza0kiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJo...",
"token_type": "bearer",
"expires_in": 3600,
"expires_at": 1734096290,
"refresh_token": "h-enkJrn3JL3Xmln7cv9mA"
}
}
}

Organisation Profiles

Create a new organisation cultural profile

This operation creates a new cultural profile for the current authenticated user.

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Organisation cultural profile

name required	string name of organisation cultural profile
website required	string website of organisation cultural profile
email	string email address of organisation cultural profile, if not supplied will be set to empty string
category required	string Enum: "Circus" "CombinedArts" "Comedy" "CommunitySpace" "Craft" "Dance" "Festival" "Educational" "FilmCinema" "Gallery" "ImmersiveAndVR" "Library" "Museum" "Music" "Theatre" "VisualArt" "VisitorAttraction" "FamilyFriendly" "LiteraturePoetry" category for organisation cultural profile
description required	number description of organisation cultural profile
approvalStatus	string Value: "AwaitingResponse" approval status of organisation cultural profile, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review

Responses

Request samples

Payload

Content type

application/json

{"name": "API Theatre Group",
"website": "https://www1.theatre.net.uk",
"email": "api@theatre.net.uk",
"category": "Theatre",
"description": "description goes here...."
}

Response samples

Content type

application/json

{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"organisationId": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"approvalStatus": "ChangesRequested",
"name": "ACE DMS",
"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"category": "Museum",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"draftInfo": "{\"name\":\"ACE DMS Profile\",\"website\":\"https://www.theatre.net.uk\"}",
"declineMessage": "The application was rejected due to missing information"
}

Update a new organisation cultural profile

This operation updates draftInfo property for cultural profiles and set the approval status to Awaiting Approval

The user should be admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
profileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a profile unique id

Request Body schema: application/json
required

Organisation cultural profile

name	string name of organisation cultural profile
website	string website of organisation cultural profile
email	string email address of organisation cultural profile
category	string Enum: "Circus" "CombinedArts" "Comedy" "CommunitySpace" "Craft" "Dance" "Festival" "Educational" "FilmCinema" "Gallery" "ImmersiveAndVR" "Library" "Museum" "Music" "Theatre" "VisualArt" "VisitorAttraction" "FamilyFriendly" "LiteraturePoetry" category for organisation cultural profile
description	number description of organisation cultural profile
approvalStatus	string Value: "AwaitingResponse" approval status of organisation cultural profile, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review

Responses

Request samples

Payload

Content type

application/json

{"name": "API Theatre Group",
"description": "description goes here....",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk"
}

Response samples

Content type

application/json

{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"organisationId": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"approvalStatus": "ChangesRequested",
"name": "ACE DMS",
"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"category": "Museum",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"draftInfo": "{\"name\":\"ACE DMS Profile\",\"website\":\"https://www.theatre.net.uk\"}",
"declineMessage": "The application was rejected due to missing information"
}

Get profiles by organisation id

This operation retrieves an organisation's profiles

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"cultural": {"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"organisationId": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"approvalStatus": "ChangesRequested",
"name": "ACE DMS",
"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"category": "Museum",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"draftInfo": "{\"name\":\"ACE DMS Profile\",\"website\":\"https://www.theatre.net.uk\"}"
},
"support": {"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"organisationId": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"approvalStatus": "ChangesRequested",
"name": "ACE DMS",
"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"draftInfo": "{\"name\":\"ACE DMS Profile\",\"website\":\"https://www.theatre.net.uk\"}",
"artforms": ["FilmOrScreen"
],
"operationIn": ["England",
"Scotland"
],
"supportTypes": ["Software",
"KnowledgeBase"
],
"address1": "Avenue Street",
"address2": "2",
"city": "London",
"country": "UK",
"postcode": "SW6 4AA",
"phone": "0330 4567"
},
"proxy": {"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"organisationId": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"approvalStatus": "ChangesRequested",
"name": "ACE DMS",
"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"draftInfo": "{\"name\":\"ACE DMS Profile\",\"website\":\"https://www.theatre.net.uk\"}",
"address1": "Avenue Street",
"address2": "2",
"city": "London",
"country": "UK",
"postcode": "SW6 4AA",
"phone": "0330 4567"
}
}

Create a new organisation proxy profile

This operation creates a new proxy profile for the current authenticated user.

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Organisation proxy profile

approvalStatus	string Value: "AwaitingResponse" approvalStatus of proxy profile
name required	string name of proxy profile
website required	string website of proxy profile
email	string email of proxy profile
description required	string description for proxy profile
address1 required	string organisation id of proxy profile
address2	string address of proxy profile
city required	string address of proxy profile
country required	string country of proxy profile
postcode required	string postcode of proxy profile
phone required	string phone of proxy profile

Responses

Request samples

Payload

Content type

application/json

{"name": "Proxy Profile Name",
"website": "https://www.proxyprofile.com",
"email": "test@example.com",
"description": "This is a description for the proxy profile.",
"address1": "123 Main St",
"address2": "Suite 456",
"city": "Sample City",
"country": "Sample Country",
"postcode": "12345",
"phone": "+1234567890"
}

Response samples

Content type

application/json

{"id": "d785a591-5535-48be-bdb6-5bb612eceb0e",
"approvalStatus": "AwaitingResponse",
"name": "Proxy Profile Name",
"website": "https://www.proxyprofile.com",
"email": "test@example.com",
"description": "This is a description for the proxy profile.",
"draftInfo": "{\"name\":\"Updated Proxy Profile Name\"}",
"declineMessage": "Change something about the profile",
"address1": "123 Main St",
"address2": "Suite 456",
"city": "Sample City",
"country": "Sample Country",
"postcode": "12345",
"phone": "+1234567890"
}

Update a new organisation proxy profile

This operation updates draftInfo property for proxy profiles and set the approval status to Awaiting Approval

The user should be admin, manager or proxy manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
profileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a profile unique id

Request Body schema: application/json
required

Organisation proxy profile

approvalStatus	string Value: "AwaitingResponse" approvalStatus of proxy profile
name	string name of proxy profile
website	string website of proxy profile
email	string email of proxy profile
description	string description for proxy profile
address1	string organisation id of proxy profile
address2	string address of proxy profile
city	string address of proxy profile
country	string country of proxy profile
postcode	string postcode of proxy profile
phone	string phone of proxy profile

Responses

Request samples

Payload

Content type

application/json

{"approvalStatus": "AwaitingResponse",
"name": "Updated Proxy Profile Name"
}

Response samples

Content type

application/json

{"id": "d785a591-5535-48be-bdb6-5bb612eceb0e",
"approvalStatus": "AwaitingResponse",
"name": "Proxy Profile Name",
"website": "https://www.proxyprofile.com",
"email": "test@example.com",
"description": "This is a description for the proxy profile.",
"draftInfo": "{\"name\":\"Updated Proxy Profile Name\"}",
"declineMessage": "Change something about the profile",
"address1": "123 Main St",
"address2": "Suite 456",
"city": "Sample City",
"country": "Sample Country",
"postcode": "12345",
"phone": "+1234567890"
}

Create a new organisation support profile

This operation creates a new support profile for the current authenticated user.

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Organisation support profile

approvalStatus	string Enum: "NewApplication" "AwaitingResponse" "ChangesRequested" "Approved" "Rejected" approvalStatus of support profile
name required	string name of support profile
website required	string website of support profile
email	string email of support profile
artforms	string Enum: "CombinedArts" "Craft" "Dance" "Festivals" "FilmOrScreen" "Libraries" "Literature" "Museums" "Music" "PerformingArts" "Theatre" "VisualArts" artforms of support profile
description required	string description for support profile
operationIn	string Enum: "England" "Scotland" "Wales" "NorthernIreland" "Online" operation place of support profile
supportTypes	string Enum: "AccessAuditing" "AudioDescription" "BritishSignLanguage" "Captioning" "Coaching" "Consultancy" "EasyRead" "IrishSignLanguage" "KnowledgeBase" "Makaton" "Mentoring" "SupportLine" "SignSupportedEnglish" "Software" "Streaming" "Training" "UsabilityTesting" support types of support profile
address1 required	string organisation id of support profile
address2	string address of support profile
city required	string address of support profile
country required	string country of support profile
postcode required	string postcode of support profile
phone required	string phone of support profile

Responses

Request samples

Payload

Content type

application/json

{"name": "ACE DMS",
"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"artforms": ["FilmOrScreen"
],
"operationIn": ["England",
"Scotland"
],
"supportTypes": ["Software",
"KnowledgeBase"
],
"address1": "Avenue Street",
"address2": "2",
"city": "London",
"country": "UK",
"postcode": "SW6 4AA",
"phone": "0330 4567"
}

Response samples

Content type

application/json

{"id": "string",
"approvalStatus": "NewApplication",
"name": "string",
"website": "string",
"email": "string",
"artforms": "CombinedArts",
"description": "string",
"draftInfo": "string",
"declineMessage": "string",
"organisationId": "string",
"operationIn": "England",
"supportTypes": "AccessAuditing",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string",
"postcode": "string",
"phone": "string"
}

Update a new organisation support profile

This operation updates draftInfo property for support profiles and set the approval status to Awaiting Approval

The user should be admin, manager or support manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
profileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a profile unique id

Request Body schema: application/json
required

Organisation support profile

approvalStatus	string Enum: "NewApplication" "AwaitingResponse" "ChangesRequested" "Approved" "Rejected" approvalStatus of support profile
name	string name of support profile
website	string website of support profile
email	string email of support profile
artforms	string Enum: "CombinedArts" "Craft" "Dance" "Festivals" "FilmOrScreen" "Libraries" "Literature" "Museums" "Music" "PerformingArts" "Theatre" "VisualArts" artforms of support profile
description	string description for support profile
operationIn	string Enum: "England" "Scotland" "Wales" "NorthernIreland" "Online" operation place of support profile
supportTypes	string Enum: "AccessAuditing" "AudioDescription" "BritishSignLanguage" "Captioning" "Coaching" "Consultancy" "EasyRead" "IrishSignLanguage" "KnowledgeBase" "Makaton" "Mentoring" "SupportLine" "SignSupportedEnglish" "Software" "Streaming" "Training" "UsabilityTesting" support types of support profile
address1	string organisation id of support profile
address2	string address of support profile
city	string address of support profile
country	string country of support profile
postcode	string postcode of support profile
phone	string phone of support profile

Responses

Request samples

Payload

Content type

application/json

{"website": "https://ace-dms-cultural.example.com",
"email": "ace.dms.cultural@example.com",
"description": "ACE DMS Cultural is a cultural organisation that is dedicated to the preservation of cultural heritage",
"phone": "0330 4567"
}

Response samples

Content type

application/json

{"id": "string",
"approvalStatus": "NewApplication",
"name": "string",
"website": "string",
"email": "string",
"artforms": "CombinedArts",
"description": "string",
"draftInfo": "string",
"declineMessage": "string",
"organisationId": "string",
"operationIn": "England",
"supportTypes": "AccessAuditing",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string",
"postcode": "string",
"phone": "string"
}

Listings

Get event by id

This operation retrieves an event listing by its unique identifier.

path Parameters

eventId

required

string <uuid>

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

event unique id

Responses

Response samples

Content type

application/json

{"id": "335b7229-c912-48f3-956a-4c7d650a5907",
"name": "An Amazing Show",
"description": "Lorem ipsum dolor sit amet consectetur adipiscing elit. Maecenas cursus fermentum pulvinar.Curabitur sollicitudin eu orci at egestas. Nullam ultrices id nunc ac scelerisque.Aliquam erat volutpat. Nullam sem odio finibus nec lacus non gravida commodo velit.",
"priceRangeLow": 10,
"priceRangeHigh": 20,
"defaultBookingLink": "https://example.com/book",
"firstInstance": "2025-05-09T14:26:45.508Z",
"lastInstance": "2025-05-09T14:26:45.508Z",
"type": ["Music",
"Comedy"
],
"format": "InPerson",
"instances": [{"start": "2025-05-09T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
]
},
{"start": "2025-05-11T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
],
"zone": {"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
}
],
"location": {"name": "Event Loc Two",
"address": "",
"website": "",
"email": "",
"phone": "",
"videoUrl": null,
"videoDescription": null,
"accessInformation": "",
"euansGuide": null,
"accessAble": null,
"acceptNimbusCard": true,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo3": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"provisions": [ ],
"zones": [{"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
]
}
}

Get events for a location by filters

This operation retrieves events based on the given filters and paging information for the given location

Authorizations:

apiKeyAuth

query Parameters

pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
from	date Example: from=2024-4-4 from date
to	date Example: to=2026-12-3 to date
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Enum: "name" "from" Example: orderBy=name data property to order by
price	enum Enum: "Free" "Paid" "All" Example: price=Free price of the event, defaults to All if not specified, results will be based in priceRangeLow and PriceRangeHigh, if one of them is set to 0 then it means free, if one of them is set to bigger than 0 it means paid
filterCategories	Array of enum (EventFilterSchema) Items Enum: "AccessibleBabyFacilities" "AccessibleParking" "AccessibleToilets" "AdaptedInformation" "AssistanceAnimals" "AudioDescription" "Captioning" "ChangingPlacesToilet" "ChilledPerformance" "DementiaFriendly" "HearingLoopsAndHeadsets" "NoStrobeLightingHazeEffects" "QuietSpaces" "RelaxedPerformance" "SignLanguage" "StepFreeLevelAccess" "WheelchairAccessible" Example: filterCategories=DementiaFriendly,HearingLoopsAndHeadsets categories of event to filter events by
name	string Example: name=Music Concert name of event
type	Array of enum (schemas-EventFilterSchema) Items Enum: "ArtAndExhibitions" "Circus" "Comedy" "CoursesAndWorkshops" "Craft" "Dance" "FamiliarisationTours" "FamilyFriendly" "FilmCinema" "Festival" "ImmersiveAndVR" "LiteratureAndPoetry" "Music" "TalksAndDebates" "Theatre" "TouchTours" Example: type=Music,Comedy type of event
format	Array of enum (EventFormatFilterSchema) Items Enum: "InPerson" "Online" "Hybrid" Example: format=Hybrid,Online format of event
addressPart	string Example: addressPart=Manchester part of the address, we will search in city, postcode and country

Responses

Response samples

Content type

application/json

{"page": 1,
"total": 37,
"data": [{"id": "335b7229-c912-48f3-956a-4c7d650a5907",
"name": "An Amazing Show",
"description": "Lorem ipsum dolor sit amet consectetur adipiscing elit. Maecenas cursus fermentum pulvinar.Curabitur sollicitudin eu orci at egestas. Nullam ultrices id nunc ac scelerisque.Aliquam erat volutpat. Nullam sem odio finibus nec lacus non gravida commodo velit.",
"priceRangeLow": 10,
"priceRangeHigh": 20,
"defaultBookingLink": "https://example.com/book",
"firstInstance": "2025-05-09T14:26:45.508Z",
"lastInstance": "2025-05-09T14:26:45.508Z",
"type": ["Music",
"Comedy"
],
"format": "InPerson",
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": null,
"photo3": null,
"instances": [{"start": "2025-05-09T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
]
},
{"start": "2025-05-11T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
],
"zone": {"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
}
],
"location": {"name": "Event Loc Two",
"address": "",
"website": "",
"email": "",
"phone": "",
"videoUrl": null,
"videoDescription": null,
"accessInformation": "",
"euansGuide": null,
"accessAble": null,
"acceptNimbusCard": true,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo3": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"provisions": [ ],
"zones": [{"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
]
}
},
{"id": "335b7229-c912-48f3-956a-4c7d650a5907",
"name": "An Amazing Show",
"description": "Lorem ipsum dolor sit amet consectetur adipiscing elit. Maecenas cursus fermentum pulvinar.Curabitur sollicitudin eu orci at egestas. Nullam ultrices id nunc ac scelerisque.Aliquam erat volutpat. Nullam sem odio finibus nec lacus non gravida commodo velit.",
"firstInstance": "2025-05-09T14:26:45.508Z",
"lastInstance": "2025-05-09T14:26:45.508Z",
"type": ["Music",
"Comedy"
],
"format": "InPerson",
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": null,
"photo3": null,
"instances": [{"start": "2025-05-09T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
]
},
{"start": "2025-05-11T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
],
"zone": {"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
}
],
"location": {"name": "Event Loc Two",
"address": "",
"website": "",
"email": "",
"phone": "",
"videoUrl": null,
"videoDescription": null,
"accessInformation": "",
"euansGuide": null,
"accessAble": null,
"acceptNimbusCard": true,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo3": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"provisions": [ ],
"zones": [{"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
]
}
}
]
}

Get events by filters

This operation retrieves events based on the given filters and paging information

Authorizations:

apiKeyAuth

query Parameters

pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
from	date Example: from=2024-4-4 from date
to	date Example: to=2026-12-3 to date
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Enum: "name" "from" Example: orderBy=name data property to order by
price	enum Enum: "Free" "Paid" "All" Example: price=Free price of the event, defaults to All if not specified, results will be based in priceRangeLow and PriceRangeHigh, if one of them is set to 0 then it means free, if one of them is set to bigger than 0 it means paid
filterCategories	Array of enum (EventFilterSchema) Items Enum: "AccessibleBabyFacilities" "AccessibleParking" "AccessibleToilets" "AdaptedInformation" "AssistanceAnimals" "AudioDescription" "Captioning" "ChangingPlacesToilet" "ChilledPerformance" "DementiaFriendly" "HearingLoopsAndHeadsets" "NoStrobeLightingHazeEffects" "QuietSpaces" "RelaxedPerformance" "SignLanguage" "StepFreeLevelAccess" "WheelchairAccessible" Example: filterCategories=DementiaFriendly,HearingLoopsAndHeadsets categories of event to filter events by
name	string Example: name=Music Concert name of event
type	Array of enum (schemas-EventFilterSchema) Items Enum: "ArtAndExhibitions" "Circus" "Comedy" "CoursesAndWorkshops" "Craft" "Dance" "FamiliarisationTours" "FamilyFriendly" "FilmCinema" "Festival" "ImmersiveAndVR" "LiteratureAndPoetry" "Music" "TalksAndDebates" "Theatre" "TouchTours" Example: type=Music,Comedy type of event
format	Array of enum (EventFormatFilterSchema) Items Enum: "InPerson" "Online" "Hybrid" Example: format=Hybrid,Online format of event
addressPart	string Example: addressPart=Manchester part of the address, we will search in city, postcode and country

Responses

Response samples

Content type

application/json

{"page": 1,
"total": 37,
"data": [{"id": "335b7229-c912-48f3-956a-4c7d650a5907",
"name": "An Amazing Show",
"description": "Lorem ipsum dolor sit amet consectetur adipiscing elit. Maecenas cursus fermentum pulvinar.Curabitur sollicitudin eu orci at egestas. Nullam ultrices id nunc ac scelerisque.Aliquam erat volutpat. Nullam sem odio finibus nec lacus non gravida commodo velit.",
"priceRangeLow": 10,
"priceRangeHigh": 20,
"defaultBookingLink": "https://example.com/book",
"firstInstance": "2025-05-09T14:26:45.508Z",
"lastInstance": "2025-05-09T14:26:45.508Z",
"type": ["Music",
"Comedy"
],
"format": "InPerson",
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": null,
"photo3": null,
"instances": [{"start": "2025-05-09T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
]
},
{"start": "2025-05-11T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
],
"zone": {"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
}
],
"location": {"name": "Event Loc Two",
"address": "",
"website": "",
"email": "",
"phone": "",
"videoUrl": null,
"videoDescription": null,
"accessInformation": "",
"euansGuide": null,
"accessAble": null,
"acceptNimbusCard": true,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo3": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"provisions": [ ],
"zones": [{"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
]
}
},
{"id": "335b7229-c912-48f3-956a-4c7d650a5907",
"name": "An Amazing Show",
"description": "Lorem ipsum dolor sit amet consectetur adipiscing elit. Maecenas cursus fermentum pulvinar.Curabitur sollicitudin eu orci at egestas. Nullam ultrices id nunc ac scelerisque.Aliquam erat volutpat. Nullam sem odio finibus nec lacus non gravida commodo velit.",
"firstInstance": "2025-05-09T14:26:45.508Z",
"lastInstance": "2025-05-09T14:26:45.508Z",
"type": ["Music",
"Comedy"
],
"format": "InPerson",
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": null,
"photo3": null,
"instances": [{"start": "2025-05-09T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
]
},
{"start": "2025-05-11T14:26:45.508Z",
"provisions": [{"id": "de481886-3b60-4690-a2f1-007d339c152f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "6e9347ed-553b-465f-84c8-9505ae8dbf82",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "98d296d2-1409-4d05-8a47-bf79b980313f",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
},
{"id": "5f9c6e99-7dd9-4f46-bafa-c7a68c940956",
"description": null,
"nonCompliant": false,
"photo": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
}
}
],
"zone": {"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
}
],
"location": {"name": "Event Loc Two",
"address": "",
"website": "",
"email": "",
"phone": "",
"videoUrl": null,
"videoDescription": null,
"accessInformation": "",
"euansGuide": null,
"accessAble": null,
"acceptNimbusCard": true,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"photo1": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo2": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"photo3": {"id": "859aba5d-350c-42fb-a835-9d5b3eb03d83",
"altText": "alt text",
"filePath": "http://aws.qa.seed.jpg"
},
"provisions": [ ],
"zones": [{"name": "Zone Two",
"description": "",
"videoDescription": null,
"videoUrl": null,
"zoneType": "MultiUse",
"provisions": [ ]
}
]
}
}
]
}

Get a location listing by id

This operation retrieves a location listing by its unique identifier.

Authorizations:

apiKeyAuth

path Parameters

locationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

location unique id

Responses

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"description": "A location description",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"accessInformation": "access information of location",
"accessAble": "access able of location",
"euansGuide": "euans guide of location",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of location",
"visualStory": "https://www1.theatre.net.uk/video",
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"address1": "address1 of location",
"address2": "address2 of location",
"postcode": "postcode of location",
"city": "city of location",
"country": "country of location",
"phone": "+44 1234 567890",
"type": ["Theatre",
"Gallery"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null,
"zones": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"nonCompliant": false,
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}
],
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"nonCompliant": false,
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
],
"organisation": {"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"phone": "+44 1234 567890",
"address1": "address1 of organisation",
"address2": "address2 of organisation",
"postcode": "postcode of organisation",
"city": "city of organisation",
"country": "country of organisation",
"logo": null
},
"culturalProfile": {"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk"
}
}

Get locations by filters

This operation retrieves locations based on the given filters and paging information

Authorizations:

apiKeyAuth

query Parameters

pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Enum: "name" "acceptCeaCard" "acceptCompanionCard" "acceptNimbusCard" "acceptSunflowerLanyard" "address1" "address2" "city" "postcode" "country" "allInScheme" "email" "requiresProofOfEligibility" "website" Example: orderBy=name data property to order by
filterCategories	Array of enum (LocationFilterSchema) Items Enum: "AccessibleBabyFacilities" "AccessibleParking" "AccessibleToilets" "AdaptedInformation" "AssistanceAnimals" "AudioDescription" "Captioning" "ChangingPlacesToilet" "ChilledOpening" "DementiaFriendly" "HearingLoopsAndHeadsets" "QuietSpaces" "RelaxedOpening" "StepFreeLevelAccess" "WheelchairAccessible" Example: filterCategories=RelaxedOpening,StepFreeLevelAccess provision categories for filtering locations
type	Array of strings (LocationType) Items Enum: "Circus" "CombinedArts" "Comedy" "CommunitySpace" "Craft" "Dance" "Festival" "Educational" "FilmCinema" "Gallery" "ImmersiveAndVR" "Library" "Museum" "Music" "Theatre" "VisualArt" "VisitorAttraction" "FamilyFriendly" "LiteraturePoetry" Example: type=Comedy,Library location type
name	string Example: name=City Library name of location
addressPart	string Example: addressPart=Manchester addressPart of the query, search through city, postcode, country
email	string Example: email=location@example.com contact email of location
website	string Example: website=https://www.locationwebsite.com website URL of location
acceptCeaCard	boolean Example: acceptCeaCard=true whether the location accepts CEA card
acceptCompanionCard	boolean Example: acceptCompanionCard=true whether the location accepts Companion card
acceptNimbusCard	boolean Example: acceptNimbusCard=true whether the location accepts Nimbus card
acceptSunflowerLanyard	boolean Example: acceptSunflowerLanyard=true whether the location accepts Sunflower lanyard
requiresProofOfEligibility	boolean Example: requiresProofOfEligibility=true whether the location requires proof of eligibility
standardId	string Example: standardId=0b9c0ca5-bd11-403b-b456-ac5a3586b021 standard unique id

Responses

Response samples

Content type

application/json

{"page": 3,
"total": 12,
"data": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"description": "A location description",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"accessInformation": "access information of location",
"accessAble": "access able of location",
"euansGuide": "euans guide of location",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of location",
"visualStory": "https://www1.theatre.net.uk/video",
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"address1": "address1 of location",
"address2": "address2 of location",
"postcode": "postcode of location",
"city": "city of location",
"country": "country of location",
"phone": "+44 1234 567890",
"type": ["Theatre",
"Gallery"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null,
"zones": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"nonCompliant": false,
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}
],
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"nonCompliant": false,
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
],
"organisation": {"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"phone": "+44 1234 567890",
"address1": "address1 of organisation",
"address2": "address2 of organisation",
"postcode": "postcode of organisation",
"city": "city of organisation",
"country": "country of organisation",
"logo": null
},
"culturalProfile": {"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk"
}
}
]
}

Get proxy profile by id

This operation retrieves a single proxy profile based on the given profile id

path Parameters

profileId

required

string

id of proxy profile in uuid format

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"website": "string",
"email": "string",
"description": "string",
"organisationId": "string",
"address1": "string",
"address2": "string",
"city": "string",
"country": "string",
"postcode": "string",
"phone": "string"
}

Get proxy profiles by filters

This operation retrieves proxy profiles based on the given filters and paging information

Authorizations:

apiKeyAuth

query Parameters

pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Enum: "name" "description" "website" "phone" "email" "address1" "address2" "postcode" "city" "country" Example: orderBy=name data property to order by
name	string Example: name=theatre
description	string Example: description=proxy profile description part of description
website	string Example: website=profile.com name or name part
phone	string Example: phone=0330 phone or phone part
email	string Example: email=info@profile.com email or email part
addressPart	string Example: addressPart=road address part to search in city, country, postcode

Responses

Response samples

Content type

application/json

{"data": [{"id": "d785a591-5535-48be-bdb6-5bb612eceb0e",
"organisationId": "ab8e2a93-aab2-46c5-9e79-ef1f68131802",
"approvalStatus": "Approved",
"name": "",
"description": "",
"website": "",
"phone": "",
"email": "test@test.com",
"address1": "Long Avenue",
"address2": "221B",
"postcode": "",
"city": "Yeovil",
"country": "United Kingdom",
"supportTypes": ["AccessAuditing",
"Mentoring"
],
"artforms": ["CombinedArts",
"Dance"
],
"operationIn": ["Scotland",
"Online"
]
},
{"id": "ad653836-2884-42db-8b13-03ad47754865",
"organisationId": "2e182ccf-acd5-41e9-a146-5715adf80cf5",
"approvalStatus": "Approved",
"name": "",
"description": "",
"website": "",
"phone": "",
"email": "test@test.com",
"address1": "Long Avenue",
"address2": "221B",
"postcode": "",
"city": "Yeovil",
"country": "United Kingdom"
},
{"id": "474c5336-ed2e-4f1e-b41b-d25b5b8d6241",
"organisationId": "171ae1b5-98b1-4017-a300-c54449220a1e",
"approvalStatus": "Approved",
"name": "",
"description": "",
"website": "",
"phone": "",
"email": "test@test.com",
"address1": "Long Avenue",
"address2": "221B",
"postcode": "",
"city": "Yeovil",
"country": "United Kingdom"
}
],
"page": 2,
"total": 20
}

Get support profile by id

This operation retrieves a single support profile based on the given profile id

path Parameters

profileId

required

string

id of support profile in uuid format

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"website": "string",
"email": "string",
"artforms": ["CombinedArts"
],
"description": "string",
"organisationId": "string",
"operationIn": ["England"
],
"supportTypes": ["AccessAuditing"
],
"address1": "string",
"address2": "string",
"city": "string",
"country": "string",
"postcode": "string",
"phone": "string"
}

Get support profiles by filters

This operation retrieves support profiles based on the given filters and paging information

Authorizations:

apiKeyAuth

query Parameters

pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Enum: "name" "description" "website" "phone" "email" "address1" "address2" "postcode" "city" "country" Example: orderBy=name data property to order by
name	string Example: name=theatre
description	string Example: description=support profile description part of description
website	string Example: website=profile.com name or name part
phone	string Example: phone=0330 phone or phone part
email	string Example: email=info@profile.com email or email part
addressPart	string Example: addressPart=road address part to search in city, country, postcode
supportTypes	string Enum: "AccessAuditing" "AudioDescription" "BritishSignLanguage" "Captioning" "Coaching" "Consultancy" "EasyRead" "IrishSignLanguage" "KnowledgeBase" "Makaton" "Mentoring" "SupportLine" "SignSupportedEnglish" "Software" "Streaming" "Training" "UsabilityTesting" Example: supportTypes=Software,EasyRead list of support types
artforms	string Enum: "CombinedArts" "Craft" "Dance" "Festivals" "FilmOrScreen" "Libraries" "Literature" "Museums" "Music" "PerformingArts" "Theatre" "VisualArts" Example: artforms=Literature,Craft,Libraries list of art forms
operationIn	string Enum: "England" "Scotland" "Wales" "NorthernIreland" "Online" Example: operationIn=Scotland list of operation places

Responses

Response samples

Content type

application/json

{"data": [{"id": "d785a591-5535-48be-bdb6-5bb612eceb0e",
"organisationId": "ab8e2a93-aab2-46c5-9e79-ef1f68131802",
"approvalStatus": "Approved",
"name": "",
"description": "",
"website": "",
"phone": "",
"email": "test@test.com",
"address1": "Long Avenue",
"address2": "221B",
"postcode": "",
"city": "Yeovil",
"country": "United Kingdom",
"supportTypes": ["AccessAuditing",
"Mentoring"
],
"artforms": ["CombinedArts",
"Dance"
],
"operationIn": ["Scotland",
"Online"
]
},
{"id": "ad653836-2884-42db-8b13-03ad47754865",
"organisationId": "2e182ccf-acd5-41e9-a146-5715adf80cf5",
"approvalStatus": "Approved",
"name": "",
"description": "",
"website": "",
"phone": "",
"email": "test@test.com",
"address1": "Long Avenue",
"address2": "221B",
"postcode": "",
"city": "Yeovil",
"country": "United Kingdom",
"supportTypes": ["AccessAuditing",
"Mentoring"
],
"artforms": ["CombinedArts",
"Dance"
],
"operationIn": ["Scotland",
"Online"
]
},
{"id": "474c5336-ed2e-4f1e-b41b-d25b5b8d6241",
"organisationId": "171ae1b5-98b1-4017-a300-c54449220a1e",
"approvalStatus": "Approved",
"name": "",
"description": "",
"website": "",
"phone": "",
"email": "test@test.com",
"address1": "Long Avenue",
"address2": "221B",
"postcode": "",
"city": "Yeovil",
"country": "United Kingdom",
"supportTypes": ["AccessAuditing",
"Mentoring"
],
"artforms": ["CombinedArts",
"Dance"
],
"operationIn": ["Scotland",
"Online"
]
}
],
"page": 2,
"total": 20
}

Get a zone listing by id

This operation retrieves a zone listing

Authorizations:

apiKeyAuth

path Parameters

zoneListingId

required

string

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

zone unique id

Responses

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"visualStory": null,
"approvalStatus": "NewApplication",
"declineMessage": null,
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Files

Get signed file URL

Retrieve the signed URL of a file.

Authorizations:

bearerAuth

path Parameters

organisationId

required

string

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

Unique identifier of the file.

Responses

Response samples

Content type

application/json

{"url": "string"
}

Generate a temporary upload URL

Generates a signed URL and a unique file ID for temporary file uploads to a specified S3 bucket.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Details of the file for which the upload URL is requested.

name

required

string

The name of the file, including its extension. Must match the regex pattern for valid file names.

Responses

Request samples

Payload

Content type

application/json

{"name": "example-file.txt"
}

Response samples

Content type

application/json

{"url": "https://example-bucket.s3.amazonaws.com/temp/example-file.txt?AWSAccessKeyId=ACCESS_KEY&Expires=1234567890&Signature=SIGNATURE",
"id": "a1b2c3d4-5678-90ef-gh12-3456789ijkl"
}

Locations

Create a new location

This operation creates a new location inside the organisation for the current authenticated user

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Location payload

name required	string name of location
description required	string description of location
address required	string address of location
website required	string website of location
email	string email address of location, if not supplied will be set to empty string
phone required	string phone of location
euansGuide required	string euansGuide for location
accessAble required	string accessAble for location
videoUrl required	string videoUrl for location
videoDescription required	string videoDescription for location
accessInformation required	string accessInformation for location
acceptNimbusCard required	boolean acceptNimbusCard for location
allInScheme required	boolean all in scheme accepted
acceptSunflowerLanyard required	boolean accept sunflower lanyard of location
acceptCeaCard required	boolean acceptCeaCard for location
acceptCompanionCard required	boolean acceptCompanionCard for location
requiresProofOfEligibility required	boolean requiresProofOfEligibility for location
photo1FileId	string fileId for photo1 for location - supply the file Id to create a new Photo
photo1AltText	string AltText for photo 1 for location - only used if the corresponding file is used
photo2FileId	string fileId for photo 2 for location - supply the file Id to create a new Photo
photo2AltText	string AltText for photo 2 for location - only used if the corresponding file is used
photo3FileId	string fileId for photo3 for location - supply the file Id to create a new Photo
photo3AltText	string AltText for photo 3 for location - only used if the corresponding file is used
approvalStatus	string Value: "AwaitingResponse" approval status of location, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review
type required	Array of strings (LocationType) Items Enum: "Circus" "CombinedArts" "Comedy" "CommunitySpace" "Craft" "Dance" "Festival" "Educational" "FilmCinema" "Gallery" "ImmersiveAndVR" "Library" "Museum" "Music" "Theatre" "VisualArt" "VisitorAttraction" "FamilyFriendly" "LiteraturePoetry" type of location, can be one or more of the following values
visualStory	string visualStory for location as url to external resource

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Location",
"description": "A location description",
"address": "Some address",
"website": "https://www.example.com",
"email": "test.location@example.com",
"phone": "0123456789",
"videoUrl": "https://www.youtube.com/watch?v=6ZfuNTqbHE8",
"videoDescription": "A video description",
"accessInformation": "Some access information",
"euansGuide": "Some euans guide information",
"accessAble": "Some access able information",
"acceptNimbusCard": true,
"allInScheme": true,
"acceptCeaCard": true,
"acceptSunflowerLanyard": true,
"acceptCompanionCard": true,
"requiresProofOfEligibility": true,
"type": ["Gallery",
"Museum"
]
}

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"description": "A location description",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"accessInformation": "access information of location",
"accessAble": "access able of location",
"euansGuide": "euans guide of location",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of location",
"declineMessage": null,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"draftInfo": "{\"address1\":\"address1 of location\",\"phone\":\"phone number of location\"}",
"approvalStatus": "NewApplication",
"visualStory": null,
"address1": "address1 of location",
"address2": "address2 of location",
"postcode": "postcode of location",
"city": "city of location",
"country": "country of location",
"phone": "phone number of location",
"type": ["Theatre",
"Gallery"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Get locations for organisation

This operation retrieves an array of locations

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"description": "A location description",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"accessInformation": "access information of location",
"accessAble": "access able of location",
"euansGuide": "euans guide of location",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of location",
"visualStory": null,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"draftInfo": "{\"address1\":\"address1 of location\",\"phone\":\"phone number of location\"}",
"approvalStatus": "NewApplication",
"declineMessage": null,
"address1": "address1 of location",
"address2": "address2 of location",
"postcode": "postcode of location",
"city": "city of location",
"country": "country of location",
"phone": "phone number of location",
"type": ["Theatre",
"Gallery"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}
]

Get a location by id inside an organisation

This operation retrieves a location

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id

Responses

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"description": "A location description",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"accessInformation": "access information of location",
"accessAble": "access able of location",
"euansGuide": "euans guide of location",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of location",
"declineMessage": null,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"draftInfo": "{\"address1\":\"address1 of location\",\"phone\":\"phone number of location\"}",
"approvalStatus": "NewApplication",
"visualStory": null,
"address1": "address1 of location",
"address2": "address2 of location",
"postcode": "postcode of location",
"city": "city of location",
"country": "country of location",
"phone": "phone number of location",
"type": ["Theatre",
"Gallery"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Update a location

This operation updates an existing location inside the organisation for the current authenticated user

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id

Request Body schema: application/json
required

Location payload

name	string name of location
address	string address of location
description	string description of location
website	string website of location
email	string email address of location
phone	string phone of location
euansGuide	string euansGuide for location
accessAble	string accessAble for location
videoUrl	string videoUrl for location
videoDescription	string videoDescription for location
accessInformation	string accessInformation for location
acceptNimbusCard	boolean acceptNimbusCard for location
allInScheme	boolean all in scheme accepted
acceptSunflowerLanyard	boolean accept sunflower lanyard of location
acceptCeaCard	boolean acceptCeaCard for location
acceptCompanionCard	boolean acceptCompanionCard for location
requiresProofOfEligibility	boolean requiresProofOfEligibility for location
photo1FileId	string fileId for photo1 for location - supply the file Id to create a new Photo
photo1AltText	string AltText for photo 1 for location - only used if the corresponding file is used
photo2FileId	string fileId for photo 2 for location - supply the file Id to create a new Photo
photo2AltText	string AltText for photo 2 for location - only used if the corresponding file is used
photo3FileId	string fileId for photo3 for location - supply the file Id to create a new Photo
photo3AltText	string AltText for photo 3 for location - only used if the corresponding file is used
approvalStatus	string Value: "AwaitingResponse" approval status of location, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review
type	Array of strings (LocationType) Items Enum: "Circus" "CombinedArts" "Comedy" "CommunitySpace" "Craft" "Dance" "Festival" "Educational" "FilmCinema" "Gallery" "ImmersiveAndVR" "Library" "Museum" "Music" "Theatre" "VisualArt" "VisitorAttraction" "FamilyFriendly" "LiteraturePoetry" type of location, can be one or more of the following values
visualStory	string visualStory for location as url to external resource

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Location",
"address": "Some address",
"website": "https://www.example.com",
"email": "test.location@example.com",
"phone": "0123456789",
"requiresProofOfEligibility": true,
"visualStory": "https://example.com/visual-story"
}

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"description": "A location description",
"email": "api@theatre.net.uk",
"website": "https://www1.theatre.net.uk",
"accessInformation": "access information of location",
"accessAble": "access able of location",
"euansGuide": "euans guide of location",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of location",
"declineMessage": null,
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"requiresProofOfEligibility": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"draftInfo": "{\"address1\":\"address1 of location\",\"phone\":\"phone number of location\"}",
"approvalStatus": "NewApplication",
"visualStory": null,
"address1": "address1 of location",
"address2": "address2 of location",
"postcode": "postcode of location",
"city": "city of location",
"country": "country of location",
"phone": "phone number of location",
"type": ["Theatre",
"Gallery"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Get provisions for a location

This operation get the provisions for a location inside the organisation.

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
]

Set provisions for a location

This operation set the provisions for a location inside the organisation, adding or updating the provisions as needed

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id

Request Body schema: application/json
required

Provisions payload

Array

standardId required	string id of the relevant Provision Category, must be one of the standard ids in the system and active for the kind of provision being set (location, eventInstance or zone)
description required	string description of the provision
	string or null id of the photo for the provision, if a photo is provided it must be one of the photos in the system. You will normally use this when keeping the photo (image and alt text) of an existing provision
	string or null id of the file to uploaded for the provision, if a file has been uploaded to the system to be used in the provision the file id should be provided here
	string or null alt text of the file provided, to be stored in the photo object when a file id is provided
nonCompliant	boolean whether the provision is partially compliant, if not provided it will default to false

Responses

Request samples

Payload

Content type

application/json

[{"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"photoId": "22222222-1111-1111-1111-111111111111"
},
{"standardId": "33333333-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"fileId": "44444444-1111-1111-1111-111111111111",
"altText": "This is the alt text of the file provided"
}
]

Response samples

Content type

application/json

[{"id": "11111111-0000-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
},
{"id": "11111111-2222-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
},
{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": true,
"nonCompliant": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "22222222-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example2.jpg",
"altText": "Example 2 alt text"
}
},
{"id": "33333333-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": true,
"nonCompliant": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "33333333-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example3.jpg",
"altText": "Example 3 alt text"
}
}
]

Event

Create a new event instance

This operation creates a new event instance for the organisation cultural profile event

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id

Request Body schema: application/json
required

Event

start required	date date and time when the event instance starts
end	date date and time when the event instance ends
zoneId	string uuid of the zone for the event instance, should be inside the location of the event
bookingLink	string external booking link for the event instance

Responses

Request samples

Payload

Content type

application/json

{"start": "2025-12-12T15:30:00.000Z",
"zoneId": "d7a91838-f255-44c8-836c-7b3c8dd83e7a"
}

Response samples

Content type

application/json

{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"start": "2025-12-12T00:00:00.000Z",
"end": "2025-12-12T02:00:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "efg45g66-1212-4545-94e8-5455678fdaab",
"providerId": "18449a84-7344-4225-94e8-f82160dc560e",
"zone": null,
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "Wheelchair Access",
"description": "The event instance is wheelchair accessible",
"Photo": {"id": "33333333-3333-3333-3333-333333333333",
"publicUrl": "https://example.com/wheelchair-access.jpg",
"altText": "Wheelchair access icon"
}
},
{"id": "22222222-2222-2222-2222-222222222222",
"name": "Sign Language Interpreter",
"description": "A sign language interpreter will be available at the event instance"
}
],
"attributes": {"EventCategory": "Theatre",
"RunningTime": "2 hours",
"AgeGuidance": "12+",
"Venue": "Main Hall",
"FacilitatedBooking": true,
"PartnerWebsite": "https://partner-website.com"
}
}

Create a new event

This operation creates a new event for the organisation cultural profile

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId

required

string <uuid>

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Event

name required	string event name
description required	string event description
locationId	string or null a location of the event
locationUrl	string or null <uri> Default: null URL for the event location
priceRangeLow	number or null Lowest ticket price
priceRangeHigh	number or null Highest ticket price
defaultBookingLink	string or null <uri> Default booking URL
photo1FileId	string fileId for photo1 for location - supply the file Id to create a new Photo
photo1AltText	string AltText for photo 1 for location - only used if the corresponding file is used
photo2FileId	string fileId for photo 2 for location - supply the file Id to create a new Photo
photo2AltText	string AltText for photo 2 for location - only used if the corresponding file is used
photo3FileId	string fileId for photo3 for location - supply the file Id to create a new Photo
photo3AltText	string AltText for photo 3 for location - only used if the corresponding file is used
status	enum Enum: "Draft" "Published" "Archived" event status, if not supplied defaults to Draft
type	Array of enum (EventType) Items Enum: "ArtAndExhibitions" "Circus" "Comedy" "CoursesAndWorkshops" "Craft" "Dance" "FamiliarisationTours" "FamilyFriendly" "FilmCinema" "Festival" "ImmersiveAndVR" "LiteratureAndPoetry" "Music" "TalksAndDebates" "Theatre" "TouchTours" type of the event
format	enum (EventFormat) Enum: "InPerson" "Online" "Hybrid" format of the event, defaults to inPerson if not supplied

Responses

Request samples

Payload

Content type

application/json

{"name": "API Performance Event",
"description": "Show is on",
"locationId": "12341234-4566-fg1e-4ee6-345eaaded9000",
"locationUrl": "https://venue.example.com/location",
"filterCategory": ["AccessibleParking",
"NoContentWarnings"
],
"priceRangeLow": 10,
"priceRangeHigh": 25,
"defaultBookingLink": "https://tickets.example.com/event/123"
}

Response samples

Content type

application/json

{"id": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"name": "Event Name",
"description": "",
"culturalOrganisationProfileId": "9adbd1a3-dbcf-4e13-bdef-d5faa9a8cc64",
"provider": "Spektrix",
"providerId": "119401AKGDPTGQQQSKKRQ",
"attributes": {"EventCategory": "",
"RunningTime": "",
"AgeGuidance": "",
"Venue": "",
"FacilitatedBooking": false,
"PartnerWebsite": ""
},
"firstInstance": "2020-12-03T00:00:00.000Z",
"lastInstance": "2021-01-09T00:00:00.000Z",
"instances": [{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"start": "2020-12-03T19:30:00.000Z",
"end": "2020-12-03T21:30:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"providerId": "119401AKGDPTGQQQSKKRQ"
},
{"id": "b1ee27d0-981d-41c7-b7aa-a0d1286dd8e3",
"start": "2021-01-09T19:30:00.000Z",
"end": "2021-01-09T21:30:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"providerId": "119401AKGDPTGQQQSKKRQ"
}
],
"instancesCount": 28,
"priceRangeLow": 10,
"priceRangeHigh": 20,
"defaultBookingLink": "https://example.com/book",
"location": null,
"type": ["Music",
"Comedy"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null,
"status": "Published",
"format": "InPerson",
"updatedByName": "Jane Doe",
"createdByName": "John Smith"
}

Get event by id

This operation retrieves an event

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id

Responses

Response samples

Content type

application/json

{"id": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"name": "Event Name",
"description": "",
"culturalOrganisationProfileId": "9adbd1a3-dbcf-4e13-bdef-d5faa9a8cc64",
"provider": "Spektrix",
"providerId": "119401AKGDPTGQQQSKKRQ",
"attributes": {"EventCategory": "",
"RunningTime": "",
"AgeGuidance": "",
"Venue": "",
"FacilitatedBooking": false,
"PartnerWebsite": ""
},
"firstInstance": "2020-12-03T00:00:00.000Z",
"lastInstance": "2021-01-09T00:00:00.000Z",
"instances": [{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"start": "2020-12-03T19:30:00.000Z",
"end": "2020-12-03T21:30:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"providerId": "119401AKGDPTGQQQSKKRQ"
},
{"id": "b1ee27d0-981d-41c7-b7aa-a0d1286dd8e3",
"start": "2021-01-09T19:30:00.000Z",
"end": "2021-01-09T21:30:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"providerId": "119401AKGDPTGQQQSKKRQ"
}
],
"instancesCount": 28,
"priceRangeLow": 10,
"priceRangeHigh": 20,
"defaultBookingLink": "https://example.com/book",
"location": null,
"type": ["Music",
"Comedy"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null,
"status": "Published",
"format": "InPerson",
"updatedByName": "Jane Doe",
"createdByName": "John Smith"
}

Update an event

This operation updates an event for the organisation cultural profile

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId required	string <uuid> Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	string <uuid> Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id

Request Body schema: application/json
required

Event

name	string event name
description	string event description
	string or null a location of the event
locationUrl	string or null <uri> URL for the event location
priceRangeLow	number or null Lowest ticket price
priceRangeHigh	number or null Highest ticket price
defaultBookingLink	string or null <uri> Default booking URL
photo1FileId	string fileId for photo1 for location - supply the file Id to create a new Photo
photo1AltText	string AltText for photo 1 for location - only used if the corresponding file is used
photo2FileId	string fileId for photo 2 for location - supply the file Id to create a new Photo
photo2AltText	string AltText for photo 2 for location - only used if the corresponding file is used
photo3FileId	string fileId for photo3 for location - supply the file Id to create a new Photo
photo3AltText	string AltText for photo 3 for location - only used if the corresponding file is used
status	enum Enum: "Draft" "Published" "Archived" event status
type	Array of enum (EventType) Items Enum: "ArtAndExhibitions" "Circus" "Comedy" "CoursesAndWorkshops" "Craft" "Dance" "FamiliarisationTours" "FamilyFriendly" "FilmCinema" "Festival" "ImmersiveAndVR" "LiteratureAndPoetry" "Music" "TalksAndDebates" "Theatre" "TouchTours" type of the event
format	enum (EventFormat) Enum: "InPerson" "Online" "Hybrid" format of the event

Responses

Request samples

Payload

Content type

application/json

{"name": "API Performance Event",
"description": "Show is on",
"locationId": "12341234-4566-fg1e-4ee6-345eaaded9000",
"locationUrl": "https://venue.example.com/location",
"filterCategory": ["AccessibleParking",
"NoContentWarnings"
],
"priceRangeLow": 10,
"priceRangeHigh": 25,
"defaultBookingLink": "https://tickets.example.com/event/123"
}

Response samples

Content type

application/json

{"id": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"name": "Event Name",
"description": "",
"culturalOrganisationProfileId": "9adbd1a3-dbcf-4e13-bdef-d5faa9a8cc64",
"provider": "Spektrix",
"providerId": "119401AKGDPTGQQQSKKRQ",
"attributes": {"EventCategory": "",
"RunningTime": "",
"AgeGuidance": "",
"Venue": "",
"FacilitatedBooking": false,
"PartnerWebsite": ""
},
"firstInstance": "2020-12-03T00:00:00.000Z",
"lastInstance": "2021-01-09T00:00:00.000Z",
"instances": [{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"start": "2020-12-03T19:30:00.000Z",
"end": "2020-12-03T21:30:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"providerId": "119401AKGDPTGQQQSKKRQ"
},
{"id": "b1ee27d0-981d-41c7-b7aa-a0d1286dd8e3",
"start": "2021-01-09T19:30:00.000Z",
"end": "2021-01-09T21:30:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"providerId": "119401AKGDPTGQQQSKKRQ"
}
],
"instancesCount": 28,
"priceRangeLow": 10,
"priceRangeHigh": 20,
"defaultBookingLink": "https://example.com/book",
"location": null,
"type": ["Music",
"Comedy"
],
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null,
"status": "Published",
"format": "InPerson",
"updatedByName": "Jane Doe",
"createdByName": "John Smith"
}

Get events for an organisation

This operation retrieves an events for the organisation

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

event unique id

query Parameters

status	string Enum: "Draft" "Published" "Archived" Example: status=Published Filter by event status
pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
from	date Example: from=2024-4-4 from date
to	date Example: to=2026-12-3 to date
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Value: "name" Example: orderBy=name data property to order by
name	string Example: name=Music Concert name of event
addressPart	string Example: addressPart=Manchester part of the address, we will search in city, postcode and country
type	Array of enum (EventType) Items Enum: "ArtAndExhibitions" "Circus" "Comedy" "CoursesAndWorkshops" "Craft" "Dance" "FamiliarisationTours" "FamilyFriendly" "FilmCinema" "Festival" "ImmersiveAndVR" "LiteratureAndPoetry" "Music" "TalksAndDebates" "Theatre" "TouchTours" Example: type=Music,Comedy type of event

Responses

Response samples

Content type

application/json

{"data": [{"id": "string",
"name": "string",
"description": "string",
"culturalOrganisationProfileId": null,
"provider": "string",
"providerId": "string",
"attributes": { },
"firstInstance": null,
"lastInstance": null,
"instances": [{"id": null,
"start": "string",
"end": "string",
"bookingLink": "string",
"eventId": "string",
"providerId": "string",
"provisions": [{"id": "string",
"standardId": "string",
"description": "string",
"nonCompliant": true,
"photo": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
}
}
],
"zone": {"id": "string",
"name": "string",
"description": "string",
"zoneType": "Retail",
"videoUrl": "string",
"videoDescription": "string",
"visualStory": "string",
"photo1": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"photo2": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"photo3": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"provisions": [{"id": "string",
"standardId": "string",
"description": "string",
"nonCompliant": true,
"photo": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
}
}
]
},
"attributes": {"property1": "string",
"property2": "string"
}
}
],
"instancesCount": 0,
"priceRangeLow": 0,
"priceRangeHigh": 0,
"defaultBookingLink": "string",
"location": {"id": "string",
"name": "string",
"description": "string",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"country": "string",
"email": "string",
"phone": "string",
"website": "string",
"accessInformation": "string",
"accessAble": "string",
"euansGuide": "string",
"videoUrl": "string",
"videoDescription": "string",
"visualStory": "string",
"acceptCeaCard": true,
"acceptCompanionCard": true,
"acceptNimbusCard": true,
"allInScheme": true,
"acceptSunflowerLanyard": true,
"requiresProofOfEligibility": true,
"type": ["Circus"
],
"photo1": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"photo2": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"photo3": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"approvalStatus": "NewApplication",
"declineMessage": "string"
},
"locationUrl": "http://example.com",
"photo1": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"photo2": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"photo3": {"id": "string",
"publicUrl": "http://example.com",
"altText": "string"
},
"status": "Draft",
"type": ["ArtAndExhibitions"
],
"format": "InPerson",
"updatedByName": "string",
"createdByName": "string"
}
],
"page": 0,
"total": 0,
"example": null
}

Get event instance by id

This operation retrieves an event instance inside the organisation cultural profile

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id
eventInstanceId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event instance unique id

Responses

Response samples

Content type

application/json

{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"start": "2025-12-12T00:00:00.000Z",
"end": "2025-12-12T02:00:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "efg45g66-1212-4545-94e8-5455678fdaab",
"providerId": "18449a84-7344-4225-94e8-f82160dc560e",
"zone": null,
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "Wheelchair Access",
"description": "The event instance is wheelchair accessible",
"Photo": {"id": "33333333-3333-3333-3333-333333333333",
"publicUrl": "https://example.com/wheelchair-access.jpg",
"altText": "Wheelchair access icon"
}
},
{"id": "22222222-2222-2222-2222-222222222222",
"name": "Sign Language Interpreter",
"description": "A sign language interpreter will be available at the event instance"
}
],
"attributes": {"EventCategory": "Theatre",
"RunningTime": "2 hours",
"AgeGuidance": "12+",
"Venue": "Main Hall",
"FacilitatedBooking": true,
"PartnerWebsite": "https://partner-website.com"
}
}

Update an event instance

This operation updates an event instance for the organisation cultural profile event

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id
eventInstanceId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event instance unique id

Request Body schema: application/json
required

Event

start	date date and time when the event instance starts
end	date date and time when the event instance ends
zoneId	string uuid of the zone for the event instance, should be inside the location of the event
bookingLink	string external booking link for the event instance

Responses

Request samples

Payload

Content type

application/json

{"start": "2025-12-12T15:30:00.000Z"
}

Response samples

Content type

application/json

{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"start": "2025-12-12T00:00:00.000Z",
"end": "2025-12-12T02:00:00.000Z",
"bookingLink": "https://example.com/book-event",
"eventId": "efg45g66-1212-4545-94e8-5455678fdaab",
"providerId": "18449a84-7344-4225-94e8-f82160dc560e",
"zone": null,
"provisions": [{"id": "11111111-1111-1111-1111-111111111111",
"name": "Wheelchair Access",
"description": "The event instance is wheelchair accessible",
"Photo": {"id": "33333333-3333-3333-3333-333333333333",
"publicUrl": "https://example.com/wheelchair-access.jpg",
"altText": "Wheelchair access icon"
}
},
{"id": "22222222-2222-2222-2222-222222222222",
"name": "Sign Language Interpreter",
"description": "A sign language interpreter will be available at the event instance"
}
],
"attributes": {"EventCategory": "Theatre",
"RunningTime": "2 hours",
"AgeGuidance": "12+",
"Venue": "Main Hall",
"FacilitatedBooking": true,
"PartnerWebsite": "https://partner-website.com"
}
}

Get event instances by event id

This operation retrieves instances of an event

- The user should be the admin, manager or cultural manager of the organisation
- The organisation should be on subscription tier 2 or 3
- The organisation should be part of the pilot

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id

query Parameters

pageNumber	number Example: pageNumber=2 page number for data list
pageSize	number Example: pageSize=5 number of records per page of data
from	date Example: from=2024-4-4 from data
to	date Example: to=2026-12-3 to date
orderSort	string Enum: "asc" "desc" Example: orderSort=asc sort order for data
orderBy	string Value: "start" Example: orderBy=name data property to order by

Responses

Response samples

Content type

application/json

{"data": [{"id": "b2ef9762-5a37-4560-8b81-fb02eff1d66e",
"createdAt": "2025-03-28T16:40:05.029Z",
"updatedAt": "2025-03-31T15:38:31.110Z",
"start": "2025-03-31T15:38:31.110Z",
"providerId": "119401AKGDPTGQQQSKKRQ",
"attributes": {"BSL": "",
"AccessRamp": ""
}
}
],
"page": 1,
"total": 37
}

Get provisions for an event instance

This operation get the provisions for an event instance inside the organisation.

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id
eventInstanceId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event instance unique id

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
]

Set provisions for an event instance

This operation set the provisions for an event instance inside the organisation, adding or updating the provisions as needed

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
eventId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event unique id
eventInstanceId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a event instance unique id

Request Body schema: application/json
required

Provisions payload

Array

standardId required	string id of the relevant Provision Category, must be one of the standard ids in the system and active for the kind of provision being set (location, eventInstance or zone)
description required	string description of the provision
	string or null id of the photo for the provision, if a photo is provided it must be one of the photos in the system. You will normally use this when keeping the photo (image and alt text) of an existing provision
	string or null id of the file to uploaded for the provision, if a file has been uploaded to the system to be used in the provision the file id should be provided here
	string or null alt text of the file provided, to be stored in the photo object when a file id is provided
nonCompliant	boolean whether the provision is partially compliant, if not provided it will default to false

Responses

Request samples

Payload

Content type

application/json

[{"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"photoId": "22222222-1111-1111-1111-111111111111"
},
{"standardId": "33333333-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"fileId": "44444444-1111-1111-1111-111111111111",
"altText": "This is the alt text of the file provided"
}
]

Response samples

Content type

application/json

[{"id": "11111111-0000-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
},
{"id": "11111111-2222-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
},
{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": true,
"nonCompliant": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "22222222-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example2.jpg",
"altText": "Example 2 alt text"
}
},
{"id": "33333333-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": true,
"nonCompliant": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "33333333-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example3.jpg",
"altText": "Example 3 alt text"
}
}
]

Start import events job

This operation starts the import events job for the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"jobId": "b2ef9762-5a37-4560-8b81-fb02eff1d66e"
}

Organisation Groups

Remove an associated organisation from a group

For the given organisation id that is an associated organisation (i.e. part of a group and not the lead organisation) it will remove the organisation form the group

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	string <uuid> The ID of the organisation
organisationGroupId required	string <uuid> The ID of the organisation group entry to delete. This id is available in the organisation group get response property `associatedOrganisations[n].organisationGroupId`.

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Get profiles by organisation id

This operation retrieves an organisation group for the given id. If the organisation is a lead organisation, it will return the group details including all associated organisations. If the organisation is an associate organisation, it will return the lead organisation with itself as the only associated organisation."

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

lead organisation unique id

Responses

Response samples

Content type

application/json

{"id": "d7a91838-f255-44c8-836c-7b3c8dd83e7a",
"name": "ACE DMS",
"locationCount": 2,
"subscriptionEndDate": "2024-12-31T23:59:59.999Z",
"subscriptionTotalLocations": 2,
"associatedOrganisations": [{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"invitedStatus": "Accepted",
"organisationGroupId": "d7a91838-f255-44c8-836c-7b3c8dd83e7a",
"name": "ACE DMS Cultural 1",
"locationCount": 2,
"subscriptionEndDate": "2024-12-31T23:59:59.999Z",
"subscriptionTotalLocations": 2
},
{"id": "b90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"invitedStatus": "Accepted",
"organisationGroupId": "d7a91838-f255-44c8-836c-7b3c8dd83e7a",
"name": "ACE DMS Cultural 2",
"locationCount": 1,
"subscriptionEndDate": "2024-12-31T23:59:59.999Z",
"subscriptionTotalLocations": 1
}
]
}

invite an organisation to join a group

This operation will email the specified address in the associated organisation with an 'invite'.

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

lead organisation unique id

Request Body schema: application/json
required

Updated user object

associatedOrganisationId

string

id of invited organisation

Responses

Request samples

Payload

Content type

application/json

{"associatedOrganisationId": "8fd14455-2b0f-4551-3e2a-00cc68b3f720"
}

Response samples

Content type

application/json

{"id": "string"
}

organisation to join a group invite reply

This operation updates the status for an 'invite'

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

inviteId	string invite id, this id can be obtained from the user's profile action section for organisation group invites
status	Accepted \| Rejected invite reply status

Responses

Request samples

Payload

Content type

application/json

{"status": "Accepted",
"inviteId": "d7a91838-f255-44c8-836c-7b3c8dd83e7a"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Organisations

Create an invoice for an organisation group

Creates a Stripe invoice for a group of organisations led by the specified organisation. The leading organisation must be part of an organisation group with accepted associated organisations. All organisations in the group will have the same subscription tier and duration. Requires leading organisation to authorize.

Authorizations:

bearerAuth

path Parameters

organisationId

required

string

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

The ID of the leading organisation

Request Body schema: application/json
required

Group invoice parameters

tier required	string Enum: "Tier1" "Tier2" "Tier3" Subscription tier for all organisations in the group
duration required	string Enum: "OneYear" "TwoYears" "ThreeYears" Subscription duration for all organisations in the group
	Array of objects Array of location counts per organisation in the group. If not specified for an organisation, its current location count will be used. Cannot specify fewer locations than currently exist for any organisation.

Responses

Request samples

Payload

Content type

application/json

{"tier": "Tier2",
"duration": "OneYear",
"organisationLocations": [{"organisationId": "d7a91838-f255-44c8-836c-7b3c8dd83e7a",
"locationCount": 3
},
{"organisationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"locationCount": 2
}
]
}

Response samples

Content type

application/json

{"invoiceId": "string",
"url": "string"
}

Create an invoice for an organisation subscription

Creates a Stripe invoice for an organisation with subscription and location items based on the specified tier and duration

Authorizations:

bearerAuth

path Parameters

organisationId

required

string

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

The ID of the organisation

Request Body schema: application/json
required

Invoice parameters

tier required	string Enum: "Tier1" "Tier2" "Tier3" Subscription tier for the organisation
duration required	string Enum: "OneYear" "TwoYears" "ThreeYears" Subscription duration
locationCount required	integer >= 0 Number of locations for this organisation (optional). If not specified, current location count will be used. Cannot be less than current location count.

Responses

Request samples

Payload

Content type

application/json

{"tier": "Tier2",
"duration": "OneYear",
"locationCount": 5
}

Response samples

Content type

application/json

{"invoiceId": "string",
"url": "string"
}

List invoices for an organisation

Retrieves all invoices associated with an organisation from Stripe

Authorizations:

bearerAuth

path Parameters

organisationId

required

string

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

The ID of the organisation

query Parameters

status	string Enum: "draft" "open" "paid" "void" "uncollectible" Filter invoices by status
limit	integer [ 1 .. 100 ] Default: 10 Number of invoices to return (1-100)
startingAfter	string Cursor for pagination (invoice ID to start after)
endingBefore	string Cursor for pagination (invoice ID to end before)

Responses

Response samples

Content type

application/json

{"data": [{"id": "string",
"status": "string",
"total": 0,
"currency": "string",
"created": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"hostedInvoiceUrl": "string",
"invoicePdf": "string",
"description": "string",
"lines": [{"id": "string",
"amount": 0,
"currency": "string",
"description": "string",
"quantity": 0
}
],
"metadata": { }
}
],
"hasMore": true
}

Create a new organisation

This operation creates a new org for the current authenticated user

Authorizations:

bearerAuth

Request Body schema: application/json
required

Organisation

name required	string name of organisation
address1 required	string registered address line 1 of organisation
address2	string registered address line 2 of organisation
city	string registered address city of organisation
postcode	string registered address postcode of organisation
country	string registered address country of organisation
email	string email of organisation, if not supplied will be set to empty string
phone required	string phone number of organisation
website required	string website of organisation
ticketingSystem required	string Enum: "Spektrix" "Tessitura" "Ticketsolve" "LineUp" "Other" "None" ticketing system of organisation
ticketingSystemOther	string ticketing system of organisation if value is other
analysisTool required	string Enum: "AudienceFinder" "Illuminate" "LookerStudio" "PowerBI" "Tableau" "None" "Other" analytics tool of organisation
analysisToolOther	string analytics tool of organisation if value is other
locationCount required	number number of different locations for an organisation
hasAgreedDSA required	boolean org has agreed to DSA terms
userJobTitle required	string job title of the user creating the organisation
logoFileId	string file id of the organisation logo
logoAltText	string alt text for the organisation logo
turnover required	string Enum: "UpTo500k" "Between500kAnd1m" "Between1mAnd2m" "Between2mAnd5m" "Between5mAnd10m" "Over10m" turnover of organisation
contactPreference	string Enum: "Email" "Phone" "Any" contact preference of the organisation, default is Email
approvalStatus	string Value: "AwaitingResponse" approval status of organisation, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review

Responses

Request samples

Payload

Content type

application/json

{"name": "API Theatre Group",
"address1": "123 Name Street",
"address2": "Suite 456",
"city": "London",
"postcode": "SW1A 1AA",
"country": "United Kingdom",
"email": "api@theatre.net.uk",
"phone": "+44 (0) 123 456 7890",
"website": "https://www1.theatre.net.uk",
"ticketingSystem": "LineUp",
"locationCount": 2,
"hasAgreedDSA": true,
"turnover": "Between1mAnd2m",
"userJobTitle": "Events Coordinator",
"contactPreference": "Phone",
"analysisTool": "Other",
"analysisToolOther": "Custom CSV Analysis Tool"
}

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"address1": "address1 of organisation",
"address2": "address2 of organisation",
"postcode": "postcode of organisation",
"city": "city of organisation",
"country": "country of organisation",
"email": "api@theatre.net.uk",
"phone": "+44 (0) 123 456 7890",
"website": "https://www1.theatre.net.uk",
"ticketingSystem": "LineUp",
"ticketingSystemOther": null,
"locationCount": 2,
"hasAgreedDSA": true,
"turnover": "Between1mAnd2m",
"draftInfo": "{\"name\":\"ACE DMS\",\"website\":\"https://www.theatre.net.uk\"}",
"approvalStatus": "NewApplication",
"contactPreference": "Phone",
"declineMessage": "",
"pilot": false,
"logo": null,
"subscriptionTier": "Tier2",
"subscriptionEndDate": "2025-09-29T23:00:00.000Z",
"subscriptionTotalLocations": 2,
"analysisTool": "Other",
"analysisToolOther": "Custom CSV Analysis Tool"
}

Get organisations for user

This operation retrieves an array of orgs

Authorizations:

bearerAuth

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"address1": "address1 of organisation",
"address2": "address2 of organisation",
"postcode": "postcode of organisation",
"city": "city of organisation",
"country": "country of organisation",
"email": "api@theatre.net.uk",
"phone": "+44 (0) 123 456 7890",
"website": "https://www1.theatre.net.uk",
"ticketingSystem": "LineUp",
"ticketingSystemOther": null,
"locationCount": 2,
"hasAgreedDSA": true,
"turnover": "Between1mAnd2m",
"draftInfo": "{\"name\":\"ACE DMS\",\"website\":\"https://www.theatre.net.uk\"}",
"approvalStatus": "NewApplication",
"contactPreference": "Phone",
"declineMessage": "",
"pilot": false,
"logo": null,
"subscriptionTier": "Tier2",
"subscriptionEndDate": "2025-09-29T23:00:00.000Z",
"subscriptionTotalLocations": 2,
"analysisTool": "Tableau"
}
]

Get audit logs for organisation

This operation retrieves the logs for actions performed on organisation data

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

query Parameters

userId	uuid
isUserAdmin	boolean
action	Create \| Update \| Delete
adminAction	NewApplication \| AwaitingResponse \| ChangesRequested \| Approved \| Rejected
from	date
to	date
pageNumber	number Default: 1

Responses

Response samples

Content type

application/json

{"page": null,
"total": null,
"data": [{"id": "string",
"adminAction": null,
"adminActionNote": "string",
"action": null,
"currentState": "string",
"entityId": null,
"entityName": "string",
"isUserAdmin": true,
"organisationId": null,
"organisationName": "string",
"userId": null,
"userName": null,
"createdAt": null,
"updatedAt": null
}
]
}

Get organisation by id

This operation retrieves an org

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"address1": "address1 of organisation",
"address2": "address2 of organisation",
"postcode": "postcode of organisation",
"city": "city of organisation",
"country": "country of organisation",
"email": "api@theatre.net.uk",
"phone": "+44 (0) 123 456 7890",
"website": "https://www1.theatre.net.uk",
"ticketingSystem": "LineUp",
"ticketingSystemOther": null,
"locationCount": 2,
"hasAgreedDSA": true,
"turnover": "Between1mAnd2m",
"draftInfo": "{\"name\":\"ACE DMS\",\"website\":\"https://www.theatre.net.uk\"}",
"approvalStatus": "NewApplication",
"contactPreference": "Phone",
"declineMessage": "",
"pilot": false,
"logo": null,
"subscriptionTier": "Tier2",
"subscriptionEndDate": "2025-09-29T23:00:00.000Z",
"subscriptionTotalLocations": 2,
"analysisTool": "Other",
"analysisToolOther": "Custom CSV Analysis Tool"
}

Update organisation

This operation updates draftInfo property for orgs and set the approval status to Awaiting Approval

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Updated user object

name	string name of organisation
address1	string registered address line 1 of organisation
address2	string registered address line 2 of organisation
city	string registered address city of organisation
postcode	string registered address postcode of organisation
country	string registered address country of organisation
email	string email of organisation
phone	string phone number of organisation
website	string website of organisation
ticketingSystem	string Enum: "Spektrix" "Tessitura" "Ticketsolve" "LineUp" "Other" "None" ticketing system of organisation
ticketingSystemOther	string ticketing system of organisation if value is other
analysisTool	string Enum: "AudienceFinder" "Illuminate" "LookerStudio" "PowerBI" "Tableau" "None" "Other" analytics tool of organisation
analysisToolOther	string analytics tool of organisation if value is other
locationCount	number number of different locations for an organisation
logoFileId	string file id of the organisation logo
logoAltText	string alt text for the organisation logo
turnover	string Enum: "UpTo500k" "Between500kAnd1m" "Between1mAnd2m" "Between2mAnd5m" "Between5mAnd10m" "Over10m" turnover of organisation
contactPreference	string Enum: "Email" "Phone" "Any" contact preference of the organisation
approvalStatus	string Value: "AwaitingResponse" approval status of organisation, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate current changes in draft info are ready for review

Responses

Request samples

Payload

Content type

application/json

{"address1": "New Office Name, 123 Name Street",
"address2": "Office 456",
"city": "London",
"postcode": "SW1A 1AA",
"country": "United Kingdom",
"website": "http://www1.theatre.net.uk"
}

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group",
"address1": "address1 of organisation",
"address2": "address2 of organisation",
"postcode": "postcode of organisation",
"city": "city of organisation",
"country": "country of organisation",
"email": "api@theatre.net.uk",
"phone": "+44 (0) 123 456 7890",
"website": "https://www1.theatre.net.uk",
"ticketingSystem": "LineUp",
"ticketingSystemOther": null,
"locationCount": 2,
"hasAgreedDSA": true,
"turnover": "Between1mAnd2m",
"draftInfo": "{\"name\":\"ACE DMS\",\"website\":\"https://www.theatre.net.uk\"}",
"approvalStatus": "NewApplication",
"contactPreference": "Phone",
"declineMessage": "",
"pilot": false,
"logo": null,
"subscriptionTier": "Tier2",
"subscriptionEndDate": "2025-09-29T23:00:00.000Z",
"subscriptionTotalLocations": 2,
"analysisTool": "Other",
"analysisToolOther": "Custom CSV Analysis Tool"
}

Get organisation subscriptions

This operation retrieves all subscription configurations for an organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"totalLocations": 0,
"subscriptionEndDate": "2019-08-24T14:15:22Z",
"tierConfiguration": "Tier1",
"stripeInvoiceId": "string"
}
]

Execute organisation maintenance tasks

This operation executes multiple maintenance tasks: sends subscription renewal notifications to organisations whose subscriptions are expiring soon (14, 7, 3, 1 days before expiration), processes expired subscriptions moving organisations to Tier1 if their subscription has expired, and archives events that have all instances in the past.

Responses

Response samples

Content type

application/json

{"message": "string",
"renewalNotificationsSent": 0,
"expiredSubscriptionsProcessed": 0,
"eventsArchived": 0
}

Provider

Create ticketing provider mapping configuration

This operation creates a mapping configuration for an organisation's provider to match with the provider's custom attributes/data

If a mapping configuration already exists, it will be replaced with the new one. Otherwise the configuration will be created.

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"providerAttributes": {"AccessiblePerformance": "b12ca9ad-6e79-4436-9913-a04f12a6f599",
"AgeGuidance": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"AudioDescribed": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"BSLInterpreted": "b12ca9ad-6e79-4436-9913-a04f12a6f599",
"Captioned": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"ContactUsBookingOverride": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"DementiaFriendly": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"EventCategory": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"FacilitatedBooking": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"HasInterval": "cca8448c-60e3-4e22-aedb-f15e6728e990"
},
"providerLocations": {"26201AGBHCTNMDGTRMRCVQPKJNVHQTBBK": "ee33c011-4ddc-4fc1-9781-4837eefe3211",
"502601AGDCQDRBGHLMQPGNSSSLQSHGQDV": "d7a91838-f255-44c8-836c-7b3c8dd83e7a",
"502602ALSNPTRRKCKRCBLRKLBRPSCCNNG": "123fc011-eeee-4fc1-9781-d684129854a0"
},
"providerZones": {"473802AJTBBJKSMJMQLJPQHJPPVPTJGGN": "218c00ad-ffff-4c50-a025-b92722618df9",
"473803ABDQHQNCLDQRPDBPJLCKLSHJJST": "aaafc011-4ddc-4fc1-9781-d684129854a0",
"26202ACGMMQQPMLRTMJGDSSHKNCHJVBNT": "faccc888-4ddc-4fc1-9781-9987655639bb"
}
}

Delete a ticketing provider configuration for a profile

This operation deletes an organisation's configuration for all entities. Use in conjunction with GET and POST for managing inserts and changes for locations, zones and events

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
mappingId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a mapping id

query Parameters

mappingType

required

string

Enum: "attribute" "location" "zone"

provider mapping type

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Get ticketing provider configuration

This operation retrieves an organisation's provider if it exists

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

Example

SpektrixV3

{"provider": "SpektrixV3",
"configuration": {"apiSecretKey": "hyrA==",
"baseUrl": "https://system3.spektrix.com/here/api/v3",
"host": "system3.spektrix.com",
"username": "dev"
}
}

Update or create an organisation's ticket provider config

This operation updates or creates an organisation's provider

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Updated user object

provider	string Enum: "SpektrixV3" "Ticketsolve" "TessituraV15" provider name
	Spektrix V3 configuration (object) or Ticketsolve configuration (object) or Tessitura V15 configuration (object) object based on the provider

Responses

Request samples

Payload

Content type

application/json

Example

SpektrixV3

{"provider": "SpektrixV3",
"configuration": {"apiSecretKey": "hyrA==",
"baseUrl": "https://system3.spektrix.com/here/api/v3",
"host": "system3.spektrix.com",
"username": "dev"
}
}

Response samples

Content type

application/json

Example

SpektrixV3

{"provider": "SpektrixV3",
"configuration": {"apiSecretKey": "hyrA==",
"baseUrl": "https://system3.spektrix.com/here/api/v3",
"host": "system3.spektrix.com",
"username": "dev"
}
}

Get ticketing provider mapping configuration

This operation retrieves an organisation's custom provider mappings

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"providerAttributes": [{"id": "b12ca9ad-6e79-4436-9913-a04f12a6f599",
"providerCode": "AccessiblePerformance",
"standardId": "cca8448c-60e3-4e22-aedb-f15e6728e990"
},
{"id": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"providerCode": "AgeGuidance",
"standardId": "b12ca9ad-6e79-4436-9913-a04f12a6f599"
}
],
"providerLocations": [{"id": "ee33c011-4ddc-4fc1-9781-4837eefe3211",
"providerId": "26201AGBHCTNMDGTRMRCVQPKJNVHQTBBK",
"locationId": "b12ca9ad-6e79-4436-9913-a04f12a6f599"
}
],
"providerZones": [{"id": "218c00ad-ffff-4c50-a025-b92722618df9",
"providerId": "473802AJTBBJKSMJMQLJPQHJPPVPTJGGN",
"zoneId": "ee33c011-4ddc-4fc1-9781-4837eefe3211"
}
]
}

Get provider event information

This operation retrieves an organisation's provider event data

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"events": {"220801ABNQMCLVNHBGQHGTVSCTLNRBKNN": {"name": "Othello",
"locations": {"26201AGBHCTNMDGTRMRCVQPKJNVHQTBBK": {"name": "The Theatre",
"zones": {"26202ACGMMQQPMLRTMJGDSSHKNCHJVBNT": {"name": "Front"
},
"26203AVSTBMCBCTJRMNLPRRQMKRHRMQBT": {"name": "Balcony"
}
},
"instances": {"476601AQRNJRPJJSVSGKGDVJQVVBPRMNT": {"start": "2025-10-23T18:45:00.000Z"
}
}
}
}
},
"502604AGQDHLLDBPGMRHCTDSVLNBNLQNC": {"name": "Richard IV",
"locations": {"502603AVTCNNKCVRKDMLKGQCCSVVQHMTC": {"name": "The Theatre",
"zones": {"26202ACGMMQQPMLRTMJGDSSHKNCHJVBNT": {"name": "Front"
},
"26203AVSTBMCBCTJRMNLPRRQMKRHRMQBT": {"name": "Balcony"
}
},
"instances": {"476601AQRNJRPJJSVSGKGDVJQVVBPRMNT": {"start": "2025-10-23T18:45:00.000Z"
}
}
}
}
}
},
"attributes": ["AccessiblePerformance",
"AgeGuidance",
"AudioDescribed",
"BSLInterpreted",
"Captioned"
]
}

Get event listings from provider with configured attributes and location data

This operation retrieves an organisation's provider data configured with location data

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json

	object provider unique attribute names with DMS standard ids
	object provider unique location ids with DMS location id
	object provider unique zone ids with DMS zone ids

Responses

Request samples

Payload

Content type

application/json

{"providerAttributes": {"AccessiblePerformance": "b12ca9ad-6e79-4436-9913-a04f12a6f599",
"AgeGuidance": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"AudioDescribed": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"BSLInterpreted": "b12ca9ad-6e79-4436-9913-a04f12a6f599",
"Captioned": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"ContactUsBookingOverride": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"DementiaFriendly": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"EventCategory": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"FacilitatedBooking": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"HasInterval": "cca8448c-60e3-4e22-aedb-f15e6728e990"
},
"providerLocations": {"26201AGBHCTNMDGTRMRCVQPKJNVHQTBBK": "ee33c011-4ddc-4fc1-9781-4837eefe3211",
"502601AGDCQDRBGHLMQPGNSSSLQSHGQDV": "d7a91838-f255-44c8-836c-7b3c8dd83e7a",
"502602ALSNPTRRKCKRCBLRKLBRPSCCNNG": "123fc011-eeee-4fc1-9781-d684129854a0"
},
"providerZones": {"473802AJTBBJKSMJMQLJPQHJPPVPTJGGN": "218c00ad-ffff-4c50-a025-b92722618df9",
"473803ABDQHQNCLDQRPDBPJLCKLSHJJST": "aaafc011-4ddc-4fc1-9781-d684129854a0",
"26202ACGMMQQPMLRTMJGDSSHKNCHJVBNT": "faccc888-4ddc-4fc1-9781-9987655639bb"
}
}

Response samples

Content type

application/json

{"id": "214801AMHNJGSJHDBNHPDQLVCMBPCGSGD",
"name": "A Christmas Carol",
"description": "",
"firstInstance": "2025-11-20T19:00:00.000Z",
"lastInstance": "2026-01-17T19:00:00.000Z",
"instances": [{"id": "455601AKRVCHVTNQBBRRJNGKGPHDHSTLB",
"start": "2025-11-20T19:00:00.000Z",
"provisions": [{"id": "b12ca9ad-6e79-4436-9913-a04f12a6f599",
"name": "Accessible public transport",
"description": "There is Accessible Public Transport up to or close by.",
"filterCategory": "AccessibleParking",
"category": "Getting There"
},
{"id": "cca8448c-60e3-4e22-aedb-f15e6728e990",
"name": "Environmentally friendly routes in",
"description": "There are environmentally friendly routes up to or close by e.g. cycle routes, lift share schemes.",
"filterCategory": "AccessibleParking",
"category": "Getting There"
}
],
"zone": {"id": "218c00ad-ed1f-4c50-a025-b92722618df9",
"name": "Front Row Seats 1-6",
"description": "",
"provisions": [ ]
}
}
]
}

Organisation Users

Delete a user from an organisation

This operation removes a user from an organisation

The user should be the admin or manager of the organisation

A manager can not remove an admin of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
userId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a user unique id

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Update a user in an organisation

This operation updates a user on an organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
userId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a user unique id

Request Body schema: application/json
required

Organisation User

role	string Enum: "ADMIN" "BILLING" "TEAM_MEMBER" "MANAGER" "CULTURAL MANAGER" user role
jobTitle	string user job title

Responses

Request samples

Payload

Content type

application/json

{"role": "ADMIN",
"jobTitle": "string"
}

Response samples

Content type

application/json

{"jobTitle": "editor",
"role": "TEAM_MEMBER"
}

Cancel an invitation to join an organisation

Cancel an invitation to join an organisation. Only administrators can cancel invitations. Only invitations with 'Invited' status can be deleted - accepted, rejected, or cancelled invitations cannot be cancelled.

Authorizations:

bearerAuth

path Parameters

organisationId required	string <uuid> The ID of the organisation
inviteId required	string <uuid> The ID of the invitation to delete

Responses

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

Get users for an organisation

This operation retrieves users and invited users for an organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Responses

Response samples

Content type

application/json

{"users": [{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"firstName": "first",
"lastName": "last",
"email": "ace.dms.doc@example.com",
"userJobTitle": "Editor",
"role": "TEAM_MEMBER"
},
{"id": "34e378bb-2222-3eaa-b7aa-295egf99ab3b",
"firstName": "first",
"lastName": "last",
"email": "ace.dms.eg@example.com",
"userJobTitle": "Manager",
"role": "ADMIN"
}
],
"invitedUsers": [{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"role": "ADMIN",
"email": "ace.dms.23@example.com",
"status": "Accepted"
},
{"id": "a90ee7d0-981d-41c7-b7aa-a0d1286dd8e2",
"role": "TEAM_MEMBER",
"status": "Invited",
"email": "ace.dms.63@example.com"
}
]
}

user to join an organisation invite reply

This operation updates the status for an invite and adds them as an organisation user if accepted. Does nothing if the user is already in the organisation

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Updated user object

inviteId	string invite id
jobTitle	string user job title
status	Accepted \| Rejected invite reply status

Responses

Request samples

Payload

Content type

application/json

{"status": "Accepted",
"jobTitle": "Manager",
"inviteId": "d7a91838-f255-44c8-836c-7b3c8dd83e7a"
}

Response samples

Content type

application/json

{"code": "string",
"description": "string"
}

invite a user to join an organisation

This operation will send an email to the specified address with an 'invite'.

The email received has a link with the following shape: SERVER_URL/accept-invite?orgId=&email=&invite=&user=

The userId is only present in the link if the user is already in the system. The email and inviteId is always present.

Example url: https://allinstaging-3tc9g.projectbeta.co.uk/accept-invite?orgId=22222222-2222-2222-2222-222222222222&email=test%2Btest%40example.com&invite=33333333-3333-3333-3333-333333333333&user=11111111-1111-1111-1111-111111111111"

The user should be the admin, manager or cultural manager of the organisation The user can only invite up to the same level of privilege as themselves

Authorizations:

bearerAuth

path Parameters

organisationId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

organisation unique id

Request Body schema: application/json
required

Updated user object

email	string invitee email address
role	string Enum: "ADMIN" "BILLING" "TEAM_MEMBER" "MANAGER" "CULTURAL MANAGER" role of user

Responses

Request samples

Payload

Content type

application/json

{"email": "test@api.user",
"role": "ADMIN"
}

Response samples

Content type

application/json

{"id": "string"
}

Proxy user

invite another user to proxy for or be proxied by

This operation will email the user an invite about the proxy.

Authorizations:

bearerAuth

Request Body schema: application/json
required

invite object

principalUserId	string id of the principal user
proxyUserId	string id of the proxy user
inviter	string Enum: "Principal" "Proxy" inviter type

Responses

Request samples

Payload

Content type

application/json

{"inviter": "Principal",
"principalUserId": "1cf4b5f0-4bb9-458b-94d7-5a220978c986",
"proxyUserId": "154e9342-abfe-4cff-b89d-34f1208f08e1"
}

Response samples

Content type

application/json

{"id": "string",
"inviter": "string",
"inviteStatus": "string",
"principalUser": {"id": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
},
"proxyUser": {"id": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
}
}

invite an organisation to join a group

This operation will email the specified address in the associated organisation with an 'invite'.

The user should be the admin of the organisation

Authorizations:

bearerAuth

path Parameters

inviteId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

invite unique id

Request Body schema: application/json
required

invite reply

inviteStatus

string

Enum: "Accepted" "Rejected" "Cancelled"

status

Responses

Request samples

Payload

Content type

application/json

{"inviteStatus": "Accepted"
}

Response samples

Content type

application/json

{"id": "string",
"inviter": "string",
"inviteStatus": "string",
"principalUser": {"id": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
},
"proxyUser": {"id": "string",
"email": "string",
"firstName": "string",
"lastName": "string"
}
}

Standards

Get list of standards in the system

This operation retrieves an array of locations

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"name": "An example provision",
"description": "This is the description of the example provision",
"category": "category of provision",
"active": true,
"usedInLocation": true,
"usedInEventInstance": false,
"usedInZone": false,
"locationFilterCategory": "QuietSpaces",
"eventFilterCategory": "QuietSpaces"
},
{"id": "11111111-1111-1111-1111-111111111111",
"name": "An example provision",
"description": "This is the description of the example provision",
"category": "category of provision",
"active": true,
"usedInLocation": true,
"usedInEventInstance": false,
"usedInZone": false,
"locationFilterCategory": null,
"eventFilterCategory": null
}
]

Get a standard by id

This operation retrieves a standard by id

path Parameters

standardId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

standard unique id

Responses

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "An example provision",
"description": "This is the description of the example provision",
"category": "category of provision",
"active": true,
"usedInLocation": true,
"usedInEventInstance": false,
"usedInZone": false,
"locationFilterCategory": "QuietSpaces",
"eventFilterCategory": "QuietSpaces"
}

Member Profile

Create provision evidence

Creates a user member profile evidence for a provision

Authorizations:

bearerAuth

path Parameters

memberProfileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a member profile unique id
provisionId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a provision unique id

Request Body schema: application/json

evidenceUrl	string evidence url
evidenceDocumentTitle	string evidence document
evidenceNote	string evidence notes
evidenceSubmitted	string is evidence submitted
evidenceValidUntil	string is evidence in date
status	string evidence status

Responses

Request samples

Payload

Content type

application/json

{"evidenceUrl": "http://evidence.net/evidence.pdf",
"evidenceDocumentTitle": "title",
"evidenceNote": "notes",
"evidenceSubmitted": "11/05/2019",
"evidenceValidUntil": "11/05/2020",
"status": "Verified"
}

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Add provision to user member profile

Creates a new provision for the user member profile

Authorizations:

bearerAuth

path Parameters

memberProfileId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

member profile unique id

Request Body schema: application/json

level	string Enum: "Required" "Preferred" level of the provision
standardId	string standard unique id

Responses

Request samples

Payload

Content type

application/json

{"level": "Required",
"standardId": "45a6739e-f353-4932-aecd-455d376c4c86"
}

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Add shared profile to user member profile

Creates a new shared profile for the user member profile

Authorizations:

bearerAuth

path Parameters

memberProfileId

required

uuid

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

member profile unique id

Request Body schema: application/json

organisationId

string

organisation unique id

Responses

Request samples

Payload

Content type

application/json

{"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86"
}

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Create a user member profile

Creates a user member profile information in the database

Authorizations:

bearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Get current user member profile

Get the current user member profile information from the database

Authorizations:

bearerAuth

path Parameters

memberProfileId

required

string <uuid>

Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a

member profile unique id

Responses

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Remove provision evidence

Deletes a user member profile evidence for a provision

Authorizations:

bearerAuth

path Parameters

memberProfileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a member profile unique id
provisionId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a provision unique id
evidenceId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a evidence unique id

Responses

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Update provision evidence

Creates a user member profile evidence for a provision

Authorizations:

bearerAuth

path Parameters

memberProfileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a member profile unique id
provisionId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a provision unique id
evidenceId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a evidence unique id

Request Body schema: application/json

evidenceUrl	string evidence url
evidenceDocumentTitle	string evidence document
evidenceNote	string evidence notes
evidenceSubmitted	string is evidence submitted
evidenceValidUntil	string is evidence in date
status	string evidence status

Responses

Request samples

Payload

Content type

application/json

{"evidenceUrl": "http://evidence.net/evidence.pdf",
"evidenceDocumentTitle": "title"
}

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Remove provision from user member profile

Removes the provision from the user member profile in the database

Authorizations:

bearerAuth

path Parameters

memberProfileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a member profile unique id
provisionId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a provision unique id

Responses

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

Remove shared profile from user member profile

Removes the shared profile from the user member profile in the database

Authorizations:

bearerAuth

path Parameters

memberProfileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a member profile unique id
sharedProfileId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a shared profile unique id

Responses

Response samples

Content type

application/json

{"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"userId": "20d6739e-e334-4932-a23d-455d376c4c86",
"isIdentityVerified": true,
"organisationShares": [{"id": "3eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "20d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name"
},
{"id": "4eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "30d6739e-e334-4932-a23d-455d376c4c86",
"name": "Organisation Name 2"
}
],
"provisions": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
}
]
},
{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"level": "Required",
"standard": {"id": "45a6739e-f353-4932-aecd-455d376c4c86",
"name": "Standard Name"
},
"evidence": [{"id"": "12583f10-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": {"id": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"fileId": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"title": "document for this",
"path": "http://allin.dms-cdn.net/file.pdf"
}
},
{"id"": "aade4435-20df-4d73-9cd4-cfda2ac879b5",
"documentTitle": "title 2",
"note": "notes",
"status": "Approved",
"submitted": "2019-11-05T00:00:00.000Z",
"url": "http://evidence.net/evidence2.pdf",
"validUntil": "2020-11-05T00:00:00.000Z",
"file": null
}
]
}
]
}

User Profile

Update a user's password

Update the password of a signed-in user

Authorizations:

bearerAuth

Request Body schema: application/json
required

credentials object

password required	string password for user
confirmPassword required	string confirmed matching password for user

Responses

Request samples

Payload

Content type

application/json

{"password": "***",
"confirmPassword": "***"
}

Response samples

Content type

application/json

{"data": {"user": {"id": "29d6739e-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"confirmation_sent_at": "2024-12-13T14:10:52.768187228Z",
"user_metadata": {"email": "user123@example.net.uk",
"email_verified": false
}
}
}
}

Change current user profile

Change the current user profile information in the database

Authorizations:

bearerAuth

Request Body schema: application/json
required

name object

firstName	string new first name for the user
lastName	string new last name for the user
marketingCommunications	boolean opt-in to marketing emails
trainingCommunications	boolean opt-in to training emails

Responses

Request samples

Payload

Content type

application/json

{"firstName": "New First Name",
"trainingCommunications": true
}

Response samples

Content type

application/json

{"data": {"user": {"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"firstName": "First Name",
"lastName": "Last Name",
"marketingCommunications": true,
"trainingCommunications": true,
"memberProfileId": "8fa3b410-f353-4932-aecd-455d376c4c86",
"invites": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"organisationName": "org 2",
"organisationId": "54e3abb8-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"role": "ADMIN",
"status": "Accepted"
},
{"id": "76b5eecc-f353-4932-aecd-455d376c4c86",
"organisationName": "org 2",
"organisationId": "aaadde34-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"role": "MANAGER",
"status": "Invited"
}
],
"organisationGroupInvites": [{"id": "234e9800-f353-4932-aecd-455d37-edea239bbb47",
"inviteStatus": "Invited",
"name": "London City Theatre Group"
}
],
"actions": [{"entityId": "2eaade50-f353-4932-aecd-455d376c4c86",
"entityType": "Location",
"entityPath": "organisation/5684edd1-f353-4932-edd1-455d376c4c86/location/2eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "5684edd1-f353-4932-edd1-455d376c4c86",
"approvalStatus": "ChangeRequested",
"message": "email address incorrect",
"role": "CULTURAL_MANAGER"
},
{"entityId": "5684edd1-f353-4932-edd1-455d376c4c86",
"entityType": "Organisation",
"entityPath": "organisation/5684edd1-f353-4932-edd1-455d376c4c86",
"organisationId": "5684edd1-f353-4932-edd1-455d376c4c86",
"approvalStatus": "ChangeRequested",
"message": "logo formatting error",
"role": "CULTURAL_MANAGER"
}
],
"proxyInvites": [{"id": "fd8651a5-de47-4897-9ec7-c712818573bc",
"inviter": "Proxy",
"inviteStatus": "Invited",
"principalUser": {"id": "1cf4b5f0-4bb9-458b-94d7-5a220978c986",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
},
"proxyUser": {"id": "154e9342-abfe-4cff-b89d-34f1208f08e1",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
}
},
{"id": "fd8651a5-de47-4897-9ec7-c712818573bc",
"inviter": "Principal",
"inviteStatus": "Accepted",
"principalUser": {"id": "1cf4b5f0-4bb9-458b-94d7-5a220978c986",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
},
"proxyUser": {"id": "154e9342-abfe-4cff-b89d-34f1208f08e1",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
}
}
]
}
}
}

Get current user profile

Get the current user profile information from the database

Authorizations:

bearerAuth

Responses

Response samples

Content type

application/json

{"data": {"user": {"id": "19d6739e-f353-4932-a23d-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"firstName": "First Name",
"lastName": "Last Name",
"marketingCommunications": true,
"trainingCommunications": true,
"memberProfileId": "8fa3b410-f353-4932-aecd-455d376c4c86",
"invites": [{"id": "2eaade50-f353-4932-aecd-455d376c4c86",
"organisationName": "org 2",
"organisationId": "54e3abb8-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"role": "ADMIN",
"status": "Accepted"
},
{"id": "76b5eecc-f353-4932-aecd-455d376c4c86",
"organisationName": "org 2",
"organisationId": "aaadde34-f353-4932-aecd-455d376c4c86",
"email": "user@www1.theatre.net.uk",
"role": "MANAGER",
"status": "Invited"
}
],
"organisationGroupInvites": [{"id": "234e9800-f353-4932-aecd-455d37-edea239bbb47",
"inviteStatus": "Invited",
"name": "London City Theatre Group"
}
],
"actions": [{"entityId": "2eaade50-f353-4932-aecd-455d376c4c86",
"entityType": "Location",
"entityPath": "organisation/5684edd1-f353-4932-edd1-455d376c4c86/location/2eaade50-f353-4932-aecd-455d376c4c86",
"organisationId": "5684edd1-f353-4932-edd1-455d376c4c86",
"approvalStatus": "ChangeRequested",
"message": "email address incorrect",
"role": "CULTURAL_MANAGER"
},
{"entityId": "5684edd1-f353-4932-edd1-455d376c4c86",
"entityType": "Organisation",
"entityPath": "organisation/5684edd1-f353-4932-edd1-455d376c4c86",
"organisationId": "5684edd1-f353-4932-edd1-455d376c4c86",
"approvalStatus": "ChangeRequested",
"message": "logo formatting error",
"role": "CULTURAL_MANAGER"
}
],
"proxyInvites": [{"id": "fd8651a5-de47-4897-9ec7-c712818573bc",
"inviter": "Proxy",
"inviteStatus": "Invited",
"principalUser": {"id": "1cf4b5f0-4bb9-458b-94d7-5a220978c986",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
},
"proxyUser": {"id": "154e9342-abfe-4cff-b89d-34f1208f08e1",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
}
},
{"id": "fd8651a5-de47-4897-9ec7-c712818573bc",
"inviter": "Principal",
"inviteStatus": "Accepted",
"principalUser": {"id": "1cf4b5f0-4bb9-458b-94d7-5a220978c986",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
},
"proxyUser": {"id": "154e9342-abfe-4cff-b89d-34f1208f08e1",
"email": "email@org.com",
"firstName": "name",
"lastName": "user"
}
}
]
}
}
}

Webhooks

Handle Stripe webhook events

This endpoint handles incoming Stripe webhook events

Request Body schema: application/json
required

Stripe webhook payload

object

Raw Stripe webhook event data

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{"message": "string"
}

Zones

Create a new zone

This operation creates a new zone inside a location of the current organisation for the current authenticated user

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id

Request Body schema: application/json
required

Zone payload

name required	string name of zone
description required	string description of zone
zoneType required	string Enum: "Retail" "Gallery" "Auditorium" "MultiUse" "Outdoor" "FoodAndDrink" "Backstage" "Other" zoneType of zone
videoUrl	string videoUrl for zone
videoDescription	string videoDescription for zone
visualStory	string visual story for zone
photo1FileId	string logo1Id for zone
photo1AltText	string AltText for photo 1 for zone
photo2FileId	string logo2Id for zone
photo2AltText	string AltText for photo 2 for zone
photo3FileId	string logo3Id for zone
photo3AltText	string AltText for photo 3 for zone
approvalStatus	string Value: "AwaitingResponse" approval status of zone, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Zone",
"description": "Some description",
"videoUrl": "https://www.youtube.com/watch?v=6ZfuNTqbHE8",
"videoDescription": "A video description"
}

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"visualStory": null,
"approvalStatus": "NewApplication",
"declineMessage": null,
"draftInfo": "{\"name\":\"API Theatre Group - Zone 1\",\"description\":\"description of zone\",\"zoneType\":\"Gallery\",\"videoUrl\":\"https://www1.theatre.net.uk/video\",\"videoDescription\":\"video description of zone\"}",
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Get zones for a location in the organisation

This operation retrieves an array of zones

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"visualStory": null,
"approvalStatus": "NewApplication",
"declineMessage": null,
"draftInfo": "{\"name\":\"API Theatre Group - Zone 1\",\"description\":\"description of zone\",\"zoneType\":\"Gallery\",\"videoUrl\":\"https://www1.theatre.net.uk/video\",\"videoDescription\":\"video description of zone\"}",
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}
]

Get a zone by id inside a location in an organisation

This operation retrieves a zone

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id
zoneId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a zone unique id

Responses

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"visualStory": null,
"approvalStatus": "NewApplication",
"declineMessage": null,
"draftInfo": "{\"name\":\"API Theatre Group - Zone 1\",\"description\":\"description of zone\",\"zoneType\":\"Gallery\",\"videoUrl\":\"https://www1.theatre.net.uk/video\",\"videoDescription\":\"video description of zone\"}",
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Update a zone

This operation updates an existing zone inside a location of the organisation for the current authenticated user

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id
zoneId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a zone unique id

Request Body schema: application/json
required

Zone payload

name	string name of zone
description	string description of zone
zoneType	string Enum: "Retail" "Gallery" "Auditorium" "MultiUse" "Outdoor" "FoodAndDrink" "Backstage" "Other" zoneType of zone
videoUrl	string videoUrl for zone
videoDescription	string videoDescription for zone
visualStory	string visual story for zone
photo1FileId	string logo1Id for zone
photo1AltText	string AltText for photo 1 for zone
photo2FileId	string logo2Id for zone
photo2AltText	string AltText for photo 2 for zone
photo3FileId	string logo3Id for zone
photo3AltText	string AltText for photo 3 for zone
approvalStatus	string Value: "AwaitingResponse" approval status of zone, only valid value is 'AwaitingResponse' will change the status from the current value to 'Awaiting Approval' to indicate it is ready for review

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Zone",
"description": "Some description",
"approvalStatus": "AwaitingResponse"
}

Response samples

Content type

application/json

{"id": "11111111-1111-1111-1111-111111111111",
"name": "API Theatre Group - Zone 1",
"description": "description of zone",
"zoneType": "Gallery",
"videoUrl": "https://www1.theatre.net.uk/video",
"videoDescription": "video description of zone",
"visualStory": null,
"approvalStatus": "NewApplication",
"declineMessage": null,
"draftInfo": "{\"name\":\"API Theatre Group - Zone 1\",\"description\":\"description of zone\",\"zoneType\":\"Gallery\",\"videoUrl\":\"https://www1.theatre.net.uk/video\",\"videoDescription\":\"video description of zone\"}",
"photo1": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo2": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
},
"photo3": null
}

Get provisions for a zone

This operation get the provisions for a zone inside the organisation.

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id
zoneId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a zone unique id

Responses

Response samples

Content type

application/json

[{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
}
]

Set provisions for a zone

This operation set the provisions for a zone inside the organisation, adding or updating the provisions as needed

The user should be the admin, manager or cultural manager of the organisation

Authorizations:

bearerAuth

path Parameters

organisationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a organisation unique id
locationId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a location unique id
zoneId required	uuid Example: d7a91838-f255-44c8-836c-7b3c8dd83e7a zone unique id

Request Body schema: application/json
required

Provisions payload

Array

standardId required	string id of the relevant Provision Category, must be one of the standard ids in the system and active for the kind of provision being set (location, eventInstance or zone)
description required	string description of the provision
	string or null id of the photo for the provision, if a photo is provided it must be one of the photos in the system. You will normally use this when keeping the photo (image and alt text) of an existing provision
	string or null id of the file to uploaded for the provision, if a file has been uploaded to the system to be used in the provision the file id should be provided here
	string or null alt text of the file provided, to be stored in the photo object when a file id is provided
nonCompliant	boolean whether the provision is partially compliant, if not provided it will default to false

Responses

Request samples

Payload

Content type

application/json

[{"standardId": "11111111-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"photoId": "22222222-1111-1111-1111-111111111111"
},
{"standardId": "33333333-1111-1111-1111-111111111111",
"description": "This is the description of the example standard",
"fileId": "44444444-1111-1111-1111-111111111111",
"altText": "This is the alt text of the file provided"
}
]

Response samples

Content type

application/json

[{"id": "11111111-0000-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
},
{"id": "11111111-2222-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": false,
"nonCompliant": false,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "11111111-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example.jpg",
"altText": "Example alt text"
}
},
{"id": "11111111-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": true,
"nonCompliant": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "22222222-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example2.jpg",
"altText": "Example 2 alt text"
}
},
{"id": "33333333-1111-1111-1111-111111111111",
"standardId": "11111111-1111-1111-1111-111111111111",
"locationId": "11111111-1111-1111-1111-111111111111",
"eventId": null,
"zoneId": null,
"description": "This is the description of the example standard",
"draft": true,
"nonCompliant": true,
"createdAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z",
"photo": {"id": "33333333-1111-1111-1111-111111111111",
"publicUrl": "https://example.com/example3.jpg",
"altText": "Example 3 alt text"
}
}
]

All In DMS API (0.129.5)

All In DMS API

Introduction

API Error Response codes

Invited user status descriptions

Subscription tier descriptions

Emails

JavaScript Examples

Creating a session

Cancelling a session

Requesting a resource

Signing up a new account

Authentication

Forgot password

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Authenticate user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Log out user and invalidate session

Authorizations:

Responses

Response samples

Resend sign up email

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Provision a user

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Renew user session

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify user magic link token

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Organisation Profiles

Create a new organisation cultural profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a new organisation cultural profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get profiles by organisation id

Authorizations:

path Parameters

Responses

Response samples

Create a new organisation proxy profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update a new organisation proxy profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required