{"items":[{"type":"link","label":"TickeTing REST API v3 Reference","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"TickeTing REST API v3 Reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"TickeTing Inc.","email":"dev@ticketingevents.com","label":"dev@ticketingevents.com","withCopyButton":true,"copyContent":"dev@ticketingevents.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"TickeTing REST API v3 Reference (3.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TickeTing REST API v3 allows developers to integrate with the TickeTing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"platform, from creating hosts and events to buying and transferring tickets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This reference document will walk you through authenticating against the API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the full list of available endpoints, their permissions and functionality."},"children":[]}]}]}]}],"sectionId":"/openapi/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TickeTing API uses API keys to authenticate requests. You must provide a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid API Key in the X-API-Key header of each request you make. There are two"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ways to get a valid API Key:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a session with a valid TickeTing username and password (this gives"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access based on the user's permissions)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure an integration key from a system administrator. Integration keys grant an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access level determined by the administrator on creation."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Session Authentication and Integration Keys are covered in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Session-Management","title":"Authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section of this reference."},"children":[]}]}]}]}],"sectionId":"/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/example-request-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Request Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: a9427bf35dd3d3011a1277c9c344ae07\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: a9427bf35dd3d3011a1277c9c344ae07\n"},"children":[]}]}]}],"sectionId":"/openapi/section/authentication/example-request-header"}],"sectionId":"/openapi/section/authentication/example-request-header"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication/authentication-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omitting the X-API-Key Header from your request or specifying an empty value, will result in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the following 401 error response."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"message\": \"Your request could not be authenticated.\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"message\": \"Your request could not be authenticated.\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an invalid X-API-Key value is provided, or the provided key is valid, but does not have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission to access the requested resource, the following 403 error response is sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"message\": \"You are restricted from accessing this resource.\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"message\": \"You are restricted from accessing this resource.\"\n}\n"},"children":[]}]}]}],"sectionId":"/openapi/section/authentication/authentication-errors"}],"sectionId":"/openapi/section/authentication/authentication-errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/client-version"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Version"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests to the API must include the version of the API they wish to integrate with."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ensures compatability with the server. This is done by including the X-Client-Version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header in every request along with the expected API version. In this way the server can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicate when a client must upgrade to avoid breaking changes."},"children":[]}]}]}]}],"sectionId":"/openapi/section/client-version"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/client-version/example-request-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Request Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Client-Version: 3.0.0\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Client-Version: 3.0.0\n"},"children":[]}]}]}],"sectionId":"/openapi/section/client-version/example-request-header"}],"sectionId":"/openapi/section/client-version/example-request-header"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/client-version/client-version-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Version Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the X-Client-Version header is omitted from your request, or the provided version does"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not meet the minimum required by the API, the following 412 error response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"error\": \"Please upgrade your client to complete this request\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"error\": \"Please upgrade your client to complete this request\"\n}\n"},"children":[]}]}]}],"sectionId":"/openapi/section/client-version/client-version-errors"}],"sectionId":"/openapi/section/client-version/client-version-errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/error-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Responses"},"children":[]}]}]}]}],"sectionId":"/openapi/section/error-responses"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/error-responses/404-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests to the API can result in a 404 error for two reasons:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint you are trying to access does not exist, in which case you will see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"following response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"message\": \"The requested endpoint /invalid/endpoint does not exist on this server.\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"message\": \"The requested endpoint /invalid/endpoint does not exist on this server.\"\n}\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint you are requesting exists, but a resource cannot be located using the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"given URI. For example, trying to access an event resource with a non-existant ID such"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as /events/0000000 will result in the following response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"error\": \"There is presently no resource with the given URI.\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"error\": \"There is presently no resource with the given URI.\"\n}\n"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/error-responses/404-errors"}],"sectionId":"/openapi/section/error-responses/404-errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/error-responses/server-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Server Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This version of the API is still under development and there may be bugs and runtime errors"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"encountered while processing your request. In these cases, a 500 error response will be sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the message below. If such a message is received, please contact a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:dev@ticketingevents.com","title":"Administrator Contact"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"system administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of your request (endpoint, method, headers and payload), so they may reproduce and resolve the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"issue."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"message\": \"There was a server error while excuting this request. Please see system logs for details.\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"message\": \"There was a server error while excuting this request. Please see system logs for details.\"\n}\n"},"children":[]}]}]}],"sectionId":"/openapi/section/error-responses/server-errors"}],"sectionId":"/openapi/section/error-responses/server-errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/error-responses/other-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional error responses may be received when incorrectly accessing valid API endpoints. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"errors received, and their resolution, are specific to the requested URI and HTTP Method and details"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are provided with each endpoint's reference where applicable."},"children":[]}]}]}]}],"sectionId":"/openapi/section/error-responses/other-errors"}],"sectionId":"/openapi/section/error-responses/other-errors"}]}]}},{"type":"link","label":"Introduction","link":"/openapi/section/introduction","routeSlug":"/openapi/section/introduction","content":null},{"type":"group","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","items":[{"type":"link","label":"Example Request Header","link":"/openapi/section/authentication/example-request-header","routeSlug":"/openapi/section/authentication/example-request-header","content":null},{"type":"link","label":"Authentication Errors","link":"/openapi/section/authentication/authentication-errors","routeSlug":"/openapi/section/authentication/authentication-errors","content":null}],"content":null},{"type":"group","label":"Client Version","link":"/openapi/section/client-version","routeSlug":"/openapi/section/client-version","items":[{"type":"link","label":"Example Request Header","link":"/openapi/section/client-version/example-request-header","routeSlug":"/openapi/section/client-version/example-request-header","content":null},{"type":"link","label":"Client Version Errors","link":"/openapi/section/client-version/client-version-errors","routeSlug":"/openapi/section/client-version/client-version-errors","content":null}],"content":null},{"type":"group","label":"Error Responses","link":"/openapi/section/error-responses","routeSlug":"/openapi/section/error-responses","items":[{"type":"link","label":"404 Errors","link":"/openapi/section/error-responses/404-errors","routeSlug":"/openapi/section/error-responses/404-errors","content":null},{"type":"link","label":"Server Errors","link":"/openapi/section/error-responses/server-errors","routeSlug":"/openapi/section/error-responses/server-errors","content":null},{"type":"link","label":"Other Errors","link":"/openapi/section/error-responses/other-errors","routeSlug":"/openapi/section/error-responses/other-errors","content":null}],"content":null},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"Session Authentication","link":"/openapi/session-authentication","routeSlug":"/openapi/session-authentication","items":[{"label":"Start a new API session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/session-authentication/start_session","routeSlug":"/openapi/session-authentication/start_session","metadata":{"seo":{"title":"Start a new API session","description":"When provided with a valid username/email address and password, starts a new API session, returning the associated key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"start_session","name":"Start a new API session","isWebhook":false,"pointer":"/paths/~1sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a new API session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"When provided with a valid username/email address and password, starts a new\nAPI session, returning the associated key.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/credentials","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/credentials","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sessions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/credentials","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","404"],"pointer":"/sessions","href":"session-authentication/start_session","openApiOperationId":"start_session","summary":"Start a new API session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/credentials","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/credentials","exampleIds":["paths/~1sessions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Indicates that the session was started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1sessions/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response","exampleIds":["paths/~1sessions/post/responses/201/content/application~1json/example"]},{"code":"404","description":"No account was found matching the provided identification string","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1sessions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response","exampleIds":["paths/~1sessions/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1sessions/post/responses/201/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1sessions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session-authentication/start_session"}],"panels":[]}]},"httpPath":"/sessions"},{"label":"Retrieve an active API session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/session-authentication/continue_session","routeSlug":"/openapi/session-authentication/continue_session","metadata":{"seo":{"title":"Retrieve an active API session","description":"Returns details of the user's active API session. The session returned is based on the key used to authenticate the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"continue_session","name":"Retrieve an active API session","isWebhook":false,"pointer":"/paths/~1sessions~1active/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an active API session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details of the user's active API session. The session returned is\nbased on the key used to authenticate the request.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sessions/active","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403"],"pointer":"/sessions/active","href":"session-authentication/continue_session","openApiOperationId":"continue_session","summary":"Retrieve an active API session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user has an active session, the details of which are in the\nresponse body\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1sessions~1active/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response","exampleIds":["paths/~1sessions~1active/get/responses/200/content/application~1json/example"]},{"code":"403","description":"No session was found for the specified key, or the session has been ended.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1sessions~1active/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response","exampleIds":["paths/~1sessions~1active/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response","exampleIds":["paths/~1sessions~1active/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session-authentication/continue_session"}],"panels":[]}]},"httpPath":"/sessions/active"},{"label":"End an active API session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/session-authentication/end_session","routeSlug":"/openapi/session-authentication/end_session","metadata":{"seo":{"title":"End an active API session","description":"Ends the user's active API session based on the key used to authenticate the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"end_session","name":"End an active API session","isWebhook":false,"pointer":"/paths/~1sessions~1active/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"End an active API session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Ends the user's active API session based on the key used to authenticate the request.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sessions/active","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403"],"pointer":"/sessions/active","href":"session-authentication/end_session","openApiOperationId":"end_session","summary":"End an active API session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user's active session was ended successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"No session was found for the specified key, or the session has been ended.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1sessions~1active/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1sessions~1active/delete/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/session-authentication/end_session"}],"panels":[]}]},"httpPath":"/sessions/active"}],"content":{"contentType":"group","meta":{"name":"Session Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Session Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sessions","summary":"Start a new API session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/session-authentication/start_session","deprecated":false},{"title":"/sessions/active","summary":"Retrieve an active API session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/session-authentication/continue_session","deprecated":false},{"title":"/sessions/active","summary":"End an active API session","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/session-authentication/end_session","deprecated":false}]}]}]}]}},{"type":"group","label":"Token Authentication","link":"/openapi/token-authentication","routeSlug":"/openapi/token-authentication","items":[{"label":"Retrieve token key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/token-authentication/retrieve_token_auth","routeSlug":"/openapi/token-authentication/retrieve_token_auth","metadata":{"seo":{"title":"Retrieve token key","description":"Returns authentication key and netadata for an event admissions token. Authenticating requests with the returned key will grant access to endpoints needed for ticket redemption."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_token_auth","name":"Retrieve token key","isWebhook":false,"pointer":"/paths/~1tokens~1{code}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve token key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns authentication key and netadata for an event admissions\ntoken. Authenticating requests with the returned key will grant access to\nendpoints needed for ticket redemption.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"code","in":"path","schemaId":"schema_41","description":"8-character code that uniquely identifies an admission token","required":true}],"pointer":"/paths/~1tokens~1{code}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tokens/{code}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"code","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/tokens/{code}","href":"token-authentication/retrieve_token_auth","openApiOperationId":"retrieve_token_auth","summary":"Retrieve token key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns authentication and metadata for an admissions token\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/token","exampleIds":["paths/~1tokens~1{code}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/token","exampleIds":["paths/~1tokens~1{code}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"No admission token identified by the given code exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1tokens~1{code}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1tokens~1{code}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1tokens~1{code}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/token","exampleIds":["paths/~1tokens~1{code}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/token","exampleIds":["paths/~1tokens~1{code}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1tokens~1{code}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1tokens~1{code}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/token-authentication/retrieve_token_auth"}],"panels":[]}]},"httpPath":"/tokens/{code}"}],"content":{"contentType":"group","meta":{"name":"Token Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Token Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tokens/{code}","summary":"Retrieve token key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/token-authentication/retrieve_token_auth","deprecated":false}]}]}]}]}},{"type":"group","label":"API Integrations","link":"/openapi/api-integrations","routeSlug":"/openapi/api-integrations","items":[{"label":"Create new integration token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-integrations/create_integration","routeSlug":"/openapi/api-integrations/create_integration","metadata":{"seo":{"title":"Create new integration token","description":"Create an API integration token that can be used to authenticate requests instead of a session key. Integrations should be used where user interaction is not desirable/possible or for server to server applications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_integration","name":"Create new integration token","isWebhook":false,"pointer":"/paths/~1integrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create new integration token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an API integration token that can be used to authenticate requests\ninstead of a session key. Integrations should be used where user interaction\nis not desirable/possible or for server to server applications.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1integrations/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request","exampleIds":["paths/~1integrations/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1integrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integrations","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1integrations/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","409"],"pointer":"/integrations","href":"api-integrations/create_integration","openApiOperationId":"create_integration","summary":"Create new integration token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request","exampleIds":["paths/~1integrations/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request","exampleIds":["paths/~1integrations/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Indicates that the API integration token was successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-2","exampleIds":["paths/~1integrations/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-2","exampleIds":["paths/~1integrations/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/400/content/application~1json/example"]},{"code":"409","description":"The named API integration token already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1integrations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-2","exampleIds":["paths/~1integrations/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-2","exampleIds":["paths/~1integrations/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1integrations/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-integrations/create_integration"}],"panels":[]}]},"httpPath":"/integrations"}],"content":{"contentType":"group","meta":{"name":"API Integrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Integrations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations","summary":"Create new integration token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-integrations/create_integration","deprecated":false}]}]}]}]}},{"type":"separator","label":"User Accounts","content":null},{"type":"group","label":"Account Management","link":"/openapi/account-management","routeSlug":"/openapi/account-management","items":[{"label":"List user accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/list_accounts","routeSlug":"/openapi/account-management/list_accounts","metadata":{"seo":{"title":"List user accounts","description":"Retrieve a list of TickeTing user accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_accounts","name":"List user accounts","isWebhook":false,"pointer":"/paths/~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of TickeTing user accounts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"number","in":"query","schemaId":"schema_44","description":"If set, only returns the account with the specified number"},{"name":"email","in":"query","schemaId":"schema_44","description":"If set, only returns the account with the specified email address"},{"name":"username","in":"query","schemaId":"schema_44","description":"If set, only returns the account with the specified username"}],"pointer":"/paths/~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"number","in":"query","required":false,"schemaId":"schema_44"},{"name":"email","in":"query","required":false,"schemaId":"schema_44"},{"name":"username","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","404"],"pointer":"/accounts","href":"account-management/list_accounts","openApiOperationId":"list_accounts","summary":"List user accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of user accounts was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_45","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_45","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1accounts/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/list_accounts"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Create a new account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/create_account","routeSlug":"/openapi/account-management/create_account","metadata":{"seo":{"title":"Create a new account","description":"Create a new TickeTing user account. Most user data is optional for account creation, so there is flexibility in the stage of the onboarding process at which data is captured."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_account","name":"Create a new account","isWebhook":false,"pointer":"/paths/~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new TickeTing user account. Most user data is optional for\naccount creation, so there is flexibility in the stage of the\nonboarding process at which data is captured.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-2","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-2","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-2","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","409"],"pointer":"/accounts","href":"account-management/create_account","openApiOperationId":"create_account","summary":"Create a new account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-2","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-2","exampleIds":["paths/~1accounts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The new account was successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"]},{"code":"409","description":"The specified username or email address is already associated with an existing account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/create_account"}],"panels":[]}]},"httpPath":"/accounts"},{"label":"Retrieve account details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/retrieve_account","routeSlug":"/openapi/account-management/retrieve_account","metadata":{"seo":{"title":"Retrieve account details","description":"Returns details of the specified user account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_account","name":"Retrieve account details","isWebhook":false,"pointer":"/paths/~1accounts~1{number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve account details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details of the specified user account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403"],"pointer":"/accounts/{number}","href":"account-management/retrieve_account","openApiOperationId":"retrieve_account","summary":"Retrieve account details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the specified user account were returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access or modify this account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/retrieve_account"}],"panels":[]}]},"httpPath":"/accounts/{number}"},{"label":"Modify account details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/update_account","routeSlug":"/openapi/account-management/update_account","metadata":{"seo":{"title":"Modify account details","description":"Update the details of the specified user account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_account","name":"Modify account details","isWebhook":false,"pointer":"/paths/~1accounts~1{number}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify account details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of the specified user account\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update","exampleIds":["paths/~1accounts~1{number}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/update","exampleIds":["paths/~1accounts~1{number}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{number}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/accounts/{number}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/update","exampleIds":["paths/~1accounts~1{number}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403"],"pointer":"/accounts/{number}","href":"account-management/update_account","openApiOperationId":"update_account","summary":"Modify account details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/update","exampleIds":["paths/~1accounts~1{number}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update","exampleIds":["paths/~1accounts~1{number}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user account details were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access or modify this account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-3","exampleIds":["paths/~1accounts~1{number}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/put/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/update_account"}],"panels":[]}]},"httpPath":"/accounts/{number}"},{"label":"Remove an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/delete_account","routeSlug":"/openapi/account-management/delete_account","metadata":{"seo":{"title":"Remove an account","description":"Completely remove an account from the system. An account can only be deleted if it does not currently hold tickets to upcoming events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_account","name":"Remove an account","isWebhook":false,"pointer":"/paths/~1accounts~1{number}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove an account from the system. An account can only be deleted\nif it does not currently hold tickets to upcoming events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accounts/{number}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","409"],"pointer":"/accounts/{number}","href":"account-management/delete_account","openApiOperationId":"delete_account","summary":"Remove an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user account was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/200/content/application~1json/example"]},{"code":"409","description":"The account cannot be deleted until all active tickets have been transferred.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/200/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/delete_account"}],"panels":[]}]},"httpPath":"/accounts/{number}"},{"label":"Retrieve account preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/retrieve_account_preferences","routeSlug":"/openapi/account-management/retrieve_account_preferences","metadata":{"seo":{"title":"Retrieve account preferences","description":"Returns the user preferences for the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_account_preferences","name":"Retrieve account preferences","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1preferences/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve account preferences","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the user preferences for the account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1preferences/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/preferences","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403"],"pointer":"/accounts/{number}/preferences","href":"account-management/retrieve_account_preferences","openApiOperationId":"retrieve_account_preferences","summary":"Retrieve account preferences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of the user's account preferences.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access or modify this account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1preferences/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/retrieve_account_preferences"}],"panels":[]}]},"httpPath":"/accounts/{number}/preferences"},{"label":"Update account preferences","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/update_account_preferences","routeSlug":"/openapi/account-management/update_account_preferences","metadata":{"seo":{"title":"Update account preferences","description":"Make changes to the account's user preferences"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_account_preferences","name":"Update account preferences","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1preferences/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account preferences","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Make changes to the account's user preferences\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1preferences/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{number}~1preferences/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/accounts/{number}/preferences","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403"],"pointer":"/accounts/{number}/preferences","href":"account-management/update_account_preferences","openApiOperationId":"update_account_preferences","summary":"Update account preferences"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The user accpunt preferences were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access or modify this account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1preferences/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/preferences","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1preferences/put/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/update_account_preferences"}],"panels":[]}]},"httpPath":"/accounts/{number}/preferences"},{"label":"List account privileges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/list_account_privileges","routeSlug":"/openapi/account-management/list_account_privileges","metadata":{"seo":{"title":"List account privileges","description":"Retrieve a list of privileges granted to this user to manage various system resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_privileges","name":"List account privileges","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1privileges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List account privileges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of privileges granted to this user to manage various system resources.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1privileges/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"role","in":"query","schemaId":"schema_44","description":"If set, only returns privileges that grant the specified role"},{"name":"type","in":"query","schemaId":"schema_44","description":"If set, only returns privileges granted on resources of the specified type"}],"pointer":"/paths/~1accounts~1{number}~1privileges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/privileges","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"role","in":"query","required":false,"schemaId":"schema_44"},{"name":"type","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/accounts/{number}/privileges","href":"account-management/list_account_privileges","openApiOperationId":"list_account_privileges","summary":"List account privileges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of privileges granted to this account including their associated roles and the resources they apply to.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_46","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1privileges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1privileges/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/list_account_privileges"}],"panels":[]}]},"httpPath":"/accounts/{number}/privileges"},{"label":"List privileged hosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/list_account_hosts","routeSlug":"/openapi/account-management/list_account_hosts","metadata":{"seo":{"title":"List privileged hosts","description":"Retrieve a list of host resources for which this account has been granted access privileges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_hosts","name":"List privileged hosts","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1hosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List privileged hosts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of host resources for which this account has been granted access privileges.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1hosts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"}],"pointer":"/paths/~1accounts~1{number}~1hosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/hosts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/accounts/{number}/hosts","href":"account-management/list_account_hosts","openApiOperationId":"list_account_hosts","summary":"List privileged hosts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of host resources on which this account has been granted access privileges was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1hosts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_47","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1hosts/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/list_account_hosts"}],"panels":[]}]},"httpPath":"/accounts/{number}/hosts"},{"label":"Lookup an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-management/lookup_account","routeSlug":"/openapi/account-management/lookup_account","metadata":{"seo":{"title":"Lookup an account","description":"Test the existenc of an account using its username or email address. A user role can optionally be provided to test for the existence of accounts of a certain type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookup_account","name":"Lookup an account","isWebhook":false,"pointer":"/paths/~1lookups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Test the existenc of an account using its username or email address. A user role\ncan optionally be provided to test for the existence of accounts of a certain type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/lookup","exampleIds":["paths/~1lookups/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/lookup","exampleIds":["paths/~1lookups/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1lookups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lookups","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/lookup","exampleIds":["paths/~1lookups/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400"],"pointer":"/lookups","href":"account-management/lookup_account","openApiOperationId":"lookup_account","summary":"Lookup an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/lookup","exampleIds":["paths/~1lookups/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/lookup","exampleIds":["paths/~1lookups/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An account with the specified username or email address was found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/result","exampleIds":["paths/~1lookups/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/result","exampleIds":["paths/~1lookups/post/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1lookups/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1lookups/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1lookups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/result","exampleIds":["paths/~1lookups/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/result","exampleIds":["paths/~1lookups/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1lookups/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1lookups/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-management/lookup_account"}],"panels":[]}]},"httpPath":"/lookups"}],"content":{"contentType":"group","meta":{"name":"Account Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts","summary":"List user accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/list_accounts","deprecated":false},{"title":"/accounts","summary":"Create a new account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-management/create_account","deprecated":false},{"title":"/accounts/{number}","summary":"Retrieve account details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/retrieve_account","deprecated":false},{"title":"/accounts/{number}","summary":"Modify account details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-management/update_account","deprecated":false},{"title":"/accounts/{number}","summary":"Remove an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-management/delete_account","deprecated":false},{"title":"/accounts/{number}/preferences","summary":"Retrieve account preferences","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/retrieve_account_preferences","deprecated":false},{"title":"/accounts/{number}/preferences","summary":"Update account preferences","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-management/update_account_preferences","deprecated":false},{"title":"/accounts/{number}/privileges","summary":"List account privileges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/list_account_privileges","deprecated":false},{"title":"/accounts/{number}/hosts","summary":"List privileged hosts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-management/list_account_hosts","deprecated":false},{"title":"/lookups","summary":"Lookup an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-management/lookup_account","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Verification","link":"/openapi/account-verification","routeSlug":"/openapi/account-verification","items":[{"label":"Request verification code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-verification/request_verification_code","routeSlug":"/openapi/account-verification/request_verification_code","metadata":{"seo":{"title":"Request verification code","description":"Request that an account verification code be sent to the provided email address, if it belongs to a registered user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"request_verification_code","name":"Request verification code","isWebhook":false,"pointer":"/paths/~1verifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request verification code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"\nRequest that an account verification code be sent to the provided email address, if it belongs to a registered user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/verification_request","exampleIds":["paths/~1verifications/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/verification_request","exampleIds":["paths/~1verifications/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1verifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/verifications","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/verification_request","exampleIds":["paths/~1verifications/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","404"],"pointer":"/verifications","href":"account-verification/request_verification_code","openApiOperationId":"request_verification_code","summary":"Request verification code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/verification_request","exampleIds":["paths/~1verifications/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/verification_request","exampleIds":["paths/~1verifications/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"An account verification code was generated and sent to the provided email address, if it belongs to a registered user.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/verification_response","exampleIds":["paths/~1verifications/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/verification_response","exampleIds":["paths/~1verifications/post/responses/201/content/application~1json/example"]},{"code":"400","description":"No email address was provided with the account verification request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/400/content/application~1json/example"]},{"code":"404","description":"No account was found matching the provided username or email address","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1verifications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/verification_response","exampleIds":["paths/~1verifications/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/verification_response","exampleIds":["paths/~1verifications/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-verification/request_verification_code"}],"panels":[]}]},"httpPath":"/verifications"},{"label":"Verify account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-verification/verify_account","routeSlug":"/openapi/account-verification/verify_account","metadata":{"seo":{"title":"Verify account","description":"Verify the account if the verification code matches that sent to the account's email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verify_account","name":"Verify account","isWebhook":false,"pointer":"/paths/~1verifications~1{verification}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verify the account if the verification code matches that sent to the account's email address.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"verification","in":"path","schemaId":"schema_44","description":"Unique identifier of the account verification request.","required":true}],"pointer":"/paths/~1verifications~1{verification}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/account_verification","exampleIds":["paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/account_verification","exampleIds":["paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1verifications~1{verification}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/verifications/{verification}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"verification","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/account_verification","exampleIds":["paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","409"],"pointer":"/verifications/{verification}","href":"account-verification/verify_account","openApiOperationId":"verify_account","summary":"Verify account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/account_verification","exampleIds":["paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/account_verification","exampleIds":["paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account was successfully verified.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"The supplied account verification code was incorrect.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/400/content/application~1json/example"]},{"code":"409","description":"The account has already been verified, or the verification request has expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1verifications~1{verification}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1verifications~1{verification}/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-verification/verify_account"}],"panels":[]}]},"httpPath":"/verifications/{verification}"}],"content":{"contentType":"group","meta":{"name":"Account Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Verification","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/verifications","summary":"Request verification code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-verification/request_verification_code","deprecated":false},{"title":"/verifications/{verification}","summary":"Verify account","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/account-verification/verify_account","deprecated":false}]}]}]}]}},{"type":"group","label":"Password Reset","link":"/openapi/password-reset","routeSlug":"/openapi/password-reset","items":[{"label":"Request password reset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/password-reset/request_reset","routeSlug":"/openapi/password-reset/request_reset","metadata":{"seo":{"title":"Request password reset","description":"Request that a password reset code be sent to the provided email address, if it belongs to a registered user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"request_reset","name":"Request password reset","isWebhook":false,"pointer":"/paths/~1resets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request password reset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request that a password reset code be sent to the provided email address, if it belongs to a registered user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reset_request","exampleIds":["paths/~1resets/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/reset_request","exampleIds":["paths/~1resets/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1resets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/resets","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/reset_request","exampleIds":["paths/~1resets/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","404"],"pointer":"/resets","href":"password-reset/request_reset","openApiOperationId":"request_reset","summary":"Request password reset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/reset_request","exampleIds":["paths/~1resets/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reset_request","exampleIds":["paths/~1resets/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A password reset code was generated and sent to the provided email address, if it belongs to a registered user.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reset_response","exampleIds":["paths/~1resets/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/reset_response","exampleIds":["paths/~1resets/post/responses/201/content/application~1json/example"]},{"code":"400","description":"No email address was provided with the password reset request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/400/content/application~1json/example"]},{"code":"404","description":"No account was found matching the provided username or email address","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1resets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/reset_response","exampleIds":["paths/~1resets/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reset_response","exampleIds":["paths/~1resets/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/password-reset/request_reset"}],"panels":[]}]},"httpPath":"/resets"},{"label":"Reset password","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/password-reset/reset_password","routeSlug":"/openapi/password-reset/reset_password","metadata":{"seo":{"title":"Reset password","description":"Change the password to the value provided if the reset code matches that sent to the account's email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reset_password","name":"Reset password","isWebhook":false,"pointer":"/paths/~1resets~1{reset}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the password to the value provided if the reset code matches that sent to the account's email address.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reset","in":"path","schemaId":"schema_48","description":"Unique identifier of the reset request.","required":true}],"pointer":"/paths/~1resets~1{reset}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/password_reset","exampleIds":["paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/password_reset","exampleIds":["paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1resets~1{reset}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/resets/{reset}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"reset","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/password_reset","exampleIds":["paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","409"],"pointer":"/resets/{reset}","href":"password-reset/reset_password","openApiOperationId":"reset_password","summary":"Reset password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/password_reset","exampleIds":["paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/password_reset","exampleIds":["paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The account password was successfully reset\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"The supplied password reset code was incorrect.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/400/content/application~1json/example"]},{"code":"409","description":"The account password has already been reset, or the reset request has expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1resets~1{reset}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1resets~1{reset}/patch/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/password-reset/reset_password"}],"panels":[]}]},"httpPath":"/resets/{reset}"}],"content":{"contentType":"group","meta":{"name":"Password Reset"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Password Reset","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/resets","summary":"Request password reset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/password-reset/request_reset","deprecated":false},{"title":"/resets/{reset}","summary":"Reset password","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/password-reset/reset_password","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Activation","link":"/openapi/account-activation","routeSlug":"/openapi/account-activation","items":[{"label":"Toggle account activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activation/toggle_account","routeSlug":"/openapi/account-activation/toggle_account","metadata":{"seo":{"title":"Toggle account activation","description":"Deactivates the specified account if it is active, and activates it otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"toggle_account","name":"Toggle account activation","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1toggles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Toggle account activation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivates the specified account if it is active, and activates\nit otherwise.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1toggles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/toggle","exampleIds":["paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/toggle","exampleIds":["paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{number}~1toggles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts/{number}/toggles","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/toggle","exampleIds":["paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403"],"pointer":"/accounts/{number}/toggles","href":"account-activation/toggle_account","openApiOperationId":"toggle_account","summary":"Toggle account activation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/toggle","exampleIds":["paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/toggle","exampleIds":["paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The account's activation status was successfully toggled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The reason for toggling the account was omitted or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access or modify this account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1toggles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1toggles/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-activation/toggle_account"}],"panels":[]}]},"httpPath":"/accounts/{number}/toggles"},{"label":"Request account deletion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activation/request_deletion","routeSlug":"/openapi/account-activation/request_deletion","metadata":{"seo":{"title":"Request account deletion","description":"Notifies system administrators that the user would like to delete their account. When a deletion request is submitted, the account is immediately deactivated, and can no longer authenticate requests, pending review."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"request_deletion","name":"Request account deletion","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1deletions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request account deletion","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notifies system administrators that the user would like to delete their account.\nWhen a deletion request is submitted, the account is immediately deactivated,\nand can no longer authenticate requests, pending review.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1deletions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/deletion","exampleIds":["paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/deletion","exampleIds":["paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{number}~1deletions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts/{number}/deletions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/deletion","exampleIds":["paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","403"],"pointer":"/accounts/{number}/deletions","href":"account-activation/request_deletion","openApiOperationId":"request_deletion","summary":"Request account deletion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/deletion","exampleIds":["paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/deletion","exampleIds":["paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account deletion was successfully requested.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access or modify this account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1deletions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1deletions/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-activation/request_deletion"}],"panels":[]}]},"httpPath":"/accounts/{number}/deletions"}],"content":{"contentType":"group","meta":{"name":"Account Activation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Activation","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{number}/toggles","summary":"Toggle account activation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-activation/toggle_account","deprecated":false},{"title":"/accounts/{number}/deletions","summary":"Request account deletion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-activation/request_deletion","deprecated":false}]}]}]}]}},{"type":"group","label":"Account Activity","link":"/openapi/account-activity","routeSlug":"/openapi/account-activity","items":[{"label":"List API sessions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/list_api_session","routeSlug":"/openapi/account-activity/list_api_session","metadata":{"seo":{"title":"List API sessions","description":"Retrieve a list of API sessions opened by this user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_api_session","name":"List API sessions","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1sessions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of API sessions opened by this user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1sessions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"}],"pointer":"/paths/~1accounts~1{number}~1sessions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/sessions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/accounts/{number}/sessions","href":"account-activity/list_api_session","openApiOperationId":"list_api_session","summary":"List API sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of matching account sessions was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1sessions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_49","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1sessions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-activity/list_api_session"}],"panels":[]}]},"httpPath":"/accounts/{number}/sessions"},{"label":"Retrieve event itinerary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/view_event_itinerary","routeSlug":"/openapi/account-activity/view_event_itinerary","metadata":{"seo":{"title":"Retrieve event itinerary","description":"Retrieve a list of events, past and future, that the account has tickets for."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"view_event_itinerary","name":"Retrieve event itinerary","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve event itinerary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of events, past and future, that the account has tickets for.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"active","in":"query","schemaId":"schema_50","description":"Only returns future events if set to true, or past events if set to false"},{"name":"sort","in":"query","schemaId":"schema_51","description":"If set, determines how the returned events list is sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1accounts~1{number}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"active","in":"query","required":false,"schemaId":"schema_50"},{"name":"sort","in":"query","required":false,"schemaId":"schema_51"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/accounts/{number}/events","href":"account-activity/view_event_itinerary","openApiOperationId":"view_event_itinerary","summary":"Retrieve event itinerary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event itinerary was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_53","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_53","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1events/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-activity/view_event_itinerary"}],"panels":[]}]},"httpPath":"/accounts/{number}/events"},{"label":"Retrieve ticket wallet","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/list_ticket_wallet","routeSlug":"/openapi/account-activity/list_ticket_wallet","metadata":{"seo":{"title":"Retrieve ticket wallet","description":"Retrieve a list of tickets belonging to the specified account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_ticket_wallet","name":"Retrieve ticket wallet","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1tickets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ticket wallet","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of tickets belonging to the specified account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1tickets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"event","in":"query","schemaId":"schema_54","description":"Only return tickets that grant access to the specified event"},{"name":"section","in":"query","schemaId":"schema_54","description":"Only return tickets that grant access to the specified section"},{"name":"serial","in":"query","schemaId":"schema_44","description":"Only return tickets with serial numbers matching the pattern"},{"name":"status","in":"query","schemaId":"schema_55","description":"Only return tickets that are in one of the specified statuses"}],"pointer":"/paths/~1accounts~1{number}~1tickets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/tickets","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"event","in":"query","required":false,"schemaId":"schema_54"},{"name":"section","in":"query","required":false,"schemaId":"schema_54"},{"name":"serial","in":"query","required":false,"schemaId":"schema_44"},{"name":"status","in":"query","required":false,"schemaId":"schema_55"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","400","404"],"pointer":"/accounts/{number}/tickets","href":"account-activity/list_ticket_wallet","openApiOperationId":"list_ticket_wallet","summary":"Retrieve ticket wallet"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of matching tickets was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_56","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/200/content/application~1json/example"]},{"code":"400","description":"One or more of the specified query parameters was invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/400/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1tickets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_56","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1tickets/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-activity/list_ticket_wallet"}],"panels":[]}]},"httpPath":"/accounts/{number}/tickets"},{"label":"View transfer history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/account-activity/view_transfer_history","routeSlug":"/openapi/account-activity/view_transfer_history","metadata":{"seo":{"title":"View transfer history","description":"Retrieve the transfer history of the specified account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"view_transfer_history","name":"View transfer history","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View transfer history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the transfer history of the specified account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1transfers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"role","in":"query","schemaId":"schema_57","description":"Determines whether to return transfers for which the account holder is the sender or the recipient","required":true},{"name":"status","in":"query","schemaId":"schema_58","description":"If set, only returns transfers currently in the specified status"}],"pointer":"/paths/~1accounts~1{number}~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/transfers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"role","in":"query","required":true,"schemaId":"schema_57"},{"name":"status","in":"query","required":false,"schemaId":"schema_58"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","400","404"],"pointer":"/accounts/{number}/transfers","href":"account-activity/view_transfer_history","openApiOperationId":"view_transfer_history","summary":"View transfer history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of matching transfers was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_59","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/200/content/application~1json/example"]},{"code":"400","description":"The request did not specify whether the account holder was a sender or recipient of the transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/400/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_59","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1transfers/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-activity/view_transfer_history"}],"panels":[]}]},"httpPath":"/accounts/{number}/transfers"}],"content":{"contentType":"group","meta":{"name":"Account Activity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Activity","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{number}/sessions","summary":"List API sessions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-activity/list_api_session","deprecated":false},{"title":"/accounts/{number}/events","summary":"Retrieve event itinerary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-activity/view_event_itinerary","deprecated":false},{"title":"/accounts/{number}/tickets","summary":"Retrieve ticket wallet","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-activity/list_ticket_wallet","deprecated":false},{"title":"/accounts/{number}/transfers","summary":"View transfer history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-activity/view_transfer_history","deprecated":false}]}]}]}]}},{"type":"separator","label":"Events","content":null},{"type":"group","label":"Managing Host Accounts","link":"/openapi/managing-host-accounts","routeSlug":"/openapi/managing-host-accounts","items":[{"label":"List event hosts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/list_hosts","routeSlug":"/openapi/managing-host-accounts/list_hosts","metadata":{"seo":{"title":"List event hosts","description":"Retrieve a list of registered event hosts that match the given criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_hosts","name":"List event hosts","isWebhook":false,"pointer":"/paths/~1hosts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event hosts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of registered event hosts that match the given criteria.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"name","in":"query","schemaId":"schema_44","description":"If set, only returns hosts whose name matches the specified regular expression"},{"name":"country","in":"query","schemaId":"schema_44","description":"If set, only returns hosts based in the specified country"},{"name":"sort","in":"query","schemaId":"schema_60","description":"If set, determines how the returned hosts list is sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1hosts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"name","in":"query","required":false,"schemaId":"schema_44"},{"name":"country","in":"query","required":false,"schemaId":"schema_44"},{"name":"sort","in":"query","required":false,"schemaId":"schema_60"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/hosts","href":"managing-host-accounts/list_hosts","openApiOperationId":"list_hosts","summary":"List event hosts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of matching event hosts was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1hosts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1hosts/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_47","exampleIds":["paths/~1hosts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1hosts/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/list_hosts"}],"panels":[]}]},"httpPath":"/hosts"},{"label":"Create an event host","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/create_host","routeSlug":"/openapi/managing-host-accounts/create_host","metadata":{"seo":{"title":"Create an event host","description":"Create a new host which can list and promote events, sell tickets or request add-on services through TickeTing. The authorising user account is automatically added to the event host's list of administrators upon creation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_host","name":"Create an event host","isWebhook":false,"pointer":"/paths/~1hosts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an event host","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new host which can list and promote events, sell tickets\nor request add-on services through TickeTing. The authorising user account is\nautomatically added to the event host's list of administrators upon creation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hosts","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","409"],"pointer":"/hosts","href":"managing-host-accounts/create_host","openApiOperationId":"create_host","summary":"Create an event host"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The new host was successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/400/content/application~1json/example"]},{"code":"409","description":"An event host with the specified name already exists in the system","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/create_host"}],"panels":[]}]},"httpPath":"/hosts"},{"label":"Retrieve host details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/retrieve_host","routeSlug":"/openapi/managing-host-accounts/retrieve_host","metadata":{"seo":{"title":"Retrieve host details","description":"Retrieve the registration details of the specified host."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_host","name":"Retrieve host details","isWebhook":false,"pointer":"/paths/~1hosts~1{host}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve host details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the registration details of the specified host.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/hosts/{host}","href":"managing-host-accounts/retrieve_host","openApiOperationId":"retrieve_host","summary":"Retrieve host details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested event host were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"A host account with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/retrieve_host"}],"panels":[]}]},"httpPath":"/hosts/{host}"},{"label":"Update host details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/update_host","routeSlug":"/openapi/managing-host-accounts/update_host","metadata":{"seo":{"title":"Update host details","description":"Change the registered details of the specified event host"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_host","name":"Update host details","isWebhook":false,"pointer":"/paths/~1hosts~1{host}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update host details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the registered details of the specified event host\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts~1{host}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts~1{host}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hosts/{host}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts~1{host}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404","409"],"pointer":"/hosts/{host}","href":"managing-host-accounts/update_host","openApiOperationId":"update_host","summary":"Update host details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts~1{host}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-3","exampleIds":["paths/~1hosts~1{host}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The host details were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"A host account with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/404/content/application~1json/example"]},{"code":"409","description":"An event host with the specified name already exists in the system","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-5","exampleIds":["paths/~1hosts~1{host}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/update_host"}],"panels":[]}]},"httpPath":"/hosts/{host}"},{"label":"Remove an event host","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/delete_host","routeSlug":"/openapi/managing-host-accounts/delete_host","metadata":{"seo":{"title":"Remove an event host","description":"Completely remove a registered event host from the system. The host will no longer be able to list or promote events, sell tickets, or request add-on services through TickeTing. Any existing events listed under the removed host account will still be active in the system, and any tickets sold will remain valid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_host","name":"Remove an event host","isWebhook":false,"pointer":"/paths/~1hosts~1{host}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an event host","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove a registered event host from the system. The host\nwill no longer be able to list or promote events, sell tickets,\nor request add-on services through TickeTing. Any existing events listed\nunder the removed host account will still be active in the system, and any\ntickets sold will remain valid.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hosts/{host}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404","409"],"pointer":"/hosts/{host}","href":"managing-host-accounts/delete_host","openApiOperationId":"delete_host","summary":"Remove an event host"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event host was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"A host account with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"The host is staging, or has staged, one or more events.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/delete_host"}],"panels":[]}]},"httpPath":"/hosts/{host}"},{"label":"List host privileges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/list_host_privileges","routeSlug":"/openapi/managing-host-accounts/list_host_privileges","metadata":{"seo":{"title":"List host privileges","description":"Retrieve a list of all privileges granted on the host account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_host_privileges","name":"List host privileges","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1privileges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List host privileges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all privileges granted on the host account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1privileges/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"role","in":"query","schemaId":"schema_44","description":"If set, only returns privileges that grant the specified role"}],"pointer":"/paths/~1hosts~1{host}~1privileges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/privileges","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"role","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/privileges","href":"managing-host-accounts/list_host_privileges","openApiOperationId":"list_host_privileges","summary":"List host privileges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of privileges granted on the event host was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_46","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1privileges/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/list_host_privileges"}],"panels":[]}]},"httpPath":"/hosts/{host}/privileges"},{"label":"Grant a host privilege","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/grant_host_privilege","routeSlug":"/openapi/managing-host-accounts/grant_host_privilege","metadata":{"seo":{"title":"Grant a host privilege","description":"Grant a new privilege on the host account which allows the targetted user to perform a subset of management operations based on their assigned role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"grant_host_privilege","name":"Grant a host privilege","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1privileges/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Grant a host privilege","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Grant a new privilege on the host account which allows the targetted user\nto perform a subset of management operations based on their assigned role.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1privileges/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1privileges/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hosts/{host}/privileges","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","403","409"],"pointer":"/hosts/{host}/privileges","href":"managing-host-accounts/grant_host_privilege","openApiOperationId":"grant_host_privilege","summary":"Grant a host privilege"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The privilege was successfully granted to the user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/201/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/403/content/application~1json/example"]},{"code":"409","description":"A privilege has already been granted to the specified user on this host","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1privileges/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/grant_host_privilege"}],"panels":[]}]},"httpPath":"/hosts/{host}/privileges"},{"label":"Retrieve host privilege","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/retrieve_host_privilege","routeSlug":"/openapi/managing-host-accounts/retrieve_host_privilege","metadata":{"seo":{"title":"Retrieve host privilege","description":"Retrieve details of the specified privilege."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_host_privilege","name":"Retrieve host privilege","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve host privilege","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of the specified privilege.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"privilege","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested privilege resource","required":true}],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/privileges/{privilege}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"privilege","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/privileges/{privilege}","href":"managing-host-accounts/retrieve_host_privilege","openApiOperationId":"retrieve_host_privilege","summary":"Retrieve host privilege"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested privilege were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"No host privilege with the given URI exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/retrieve_host_privilege"}],"panels":[]}]},"httpPath":"/hosts/{host}/privileges/{privilege}"},{"label":"Update host privilege","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/update_host_privilege","routeSlug":"/openapi/managing-host-accounts/update_host_privilege","metadata":{"seo":{"title":"Update host privilege","description":"Update the role associated with the specified privilege"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_host_privilege","name":"Update host privilege","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update host privilege","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the role associated with the specified privilege\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"privilege","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested privilege resource","required":true}],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/role","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/role","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hosts/{host}/privileges/{privilege}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"privilege","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/role","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404","409"],"pointer":"/hosts/{host}/privileges/{privilege}","href":"managing-host-accounts/update_host_privilege","openApiOperationId":"update_host_privilege","summary":"Update host privilege"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/role","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/role","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The host privilege was successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"No host privilege with the given URI exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/404/content/application~1json/example"]},{"code":"409","description":"A privilege with the Owner role cannot be modified or deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-4","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/update_host_privilege"}],"panels":[]}]},"httpPath":"/hosts/{host}/privileges/{privilege}"},{"label":"Revoke a host privilege","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-host-accounts/revoke_host_privilege","routeSlug":"/openapi/managing-host-accounts/revoke_host_privilege","metadata":{"seo":{"title":"Revoke a host privilege","description":"Revoke the specified privilege, denying the associated user all permissions to manage the host account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revoke_host_privilege","name":"Revoke a host privilege","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke a host privilege","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke the specified privilege, denying the associated user all permissions\nto manage the host account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"privilege","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested privilege resource","required":true}],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hosts/{host}/privileges/{privilege}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"privilege","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404","409"],"pointer":"/hosts/{host}/privileges/{privilege}","href":"managing-host-accounts/revoke_host_privilege","openApiOperationId":"revoke_host_privilege","summary":"Revoke a host privilege"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The host privilege was successfully revoked.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"No host privilege with the given URI exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"A privilege with the Owner role cannot be modified or deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-host-accounts/revoke_host_privilege"}],"panels":[]}]},"httpPath":"/hosts/{host}/privileges/{privilege}"}],"content":{"contentType":"group","meta":{"name":"Managing Host Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managing Host Accounts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hosts","summary":"List event hosts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-host-accounts/list_hosts","deprecated":false},{"title":"/hosts","summary":"Create an event host","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managing-host-accounts/create_host","deprecated":false},{"title":"/hosts/{host}","summary":"Retrieve host details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-host-accounts/retrieve_host","deprecated":false},{"title":"/hosts/{host}","summary":"Update host details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/managing-host-accounts/update_host","deprecated":false},{"title":"/hosts/{host}","summary":"Remove an event host","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/managing-host-accounts/delete_host","deprecated":false},{"title":"/hosts/{host}/privileges","summary":"List host privileges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-host-accounts/list_host_privileges","deprecated":false},{"title":"/hosts/{host}/privileges","summary":"Grant a host privilege","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managing-host-accounts/grant_host_privilege","deprecated":false},{"title":"/hosts/{host}/privileges/{privilege}","summary":"Retrieve host privilege","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-host-accounts/retrieve_host_privilege","deprecated":false},{"title":"/hosts/{host}/privileges/{privilege}","summary":"Update host privilege","prefix":{"name":"put","color":"put"},"badges":[],"link":"/managing-host-accounts/update_host_privilege","deprecated":false},{"title":"/hosts/{host}/privileges/{privilege}","summary":"Revoke a host privilege","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/managing-host-accounts/revoke_host_privilege","deprecated":false}]}]}]}]}},{"type":"group","label":"Managing Events","link":"/openapi/managing-events","routeSlug":"/openapi/managing-events","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/list_host_events","routeSlug":"/openapi/managing-events/list_host_events","metadata":{"seo":{"title":"List events","description":"Retrieve a list of all events registered by this event host."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_host_events","name":"List events","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all events registered by this event host.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"title","in":"query","schemaId":"schema_44","description":"If set, only returns events whose title matches the specified regular expression"},{"name":"active","in":"query","schemaId":"schema_50","description":"Only returns future events if set to true, or past events if set to false"},{"name":"public","in":"query","schemaId":"schema_50","description":"Only returns public events if set to true, or private events if set to false."},{"name":"tier","in":"query","schemaId":"schema_48","description":"Only returns events associated with the specified tier."},{"name":"sort","in":"query","schemaId":"schema_51","description":"If set, determines how the returned events list is sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1hosts~1{host}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"title","in":"query","required":false,"schemaId":"schema_44"},{"name":"active","in":"query","required":false,"schemaId":"schema_50"},{"name":"public","in":"query","required":false,"schemaId":"schema_50"},{"name":"tier","in":"query","required":false,"schemaId":"schema_48"},{"name":"sort","in":"query","required":false,"schemaId":"schema_51"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/events","href":"managing-events/list_host_events","openApiOperationId":"list_host_events","summary":"List events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of registered events was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_61","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/list_host_events"}],"panels":[]}]},"httpPath":"/hosts/{host}/events"},{"label":"Register an event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/register_event","routeSlug":"/openapi/managing-events/register_event","metadata":{"seo":{"title":"Register an event","description":"Register a new event in the TickeTing system. Once submitted for review and approved by an administrator, the host can begin to sell tickets to the event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"register_event","name":"Register an event","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Register a new event in the TickeTing system. Once submitted for review and\napproved by an administrator, the host can begin to sell tickets to the event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hosts/{host}/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403"],"pointer":"/hosts/{host}/events","href":"managing-events/register_event","openApiOperationId":"register_event","summary":"Register an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The new event was successfully registered.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/register_event"}],"panels":[]}]},"httpPath":"/hosts/{host}/events"},{"label":"Retrieve event details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/retrieve_event","routeSlug":"/openapi/managing-events/retrieve_event","metadata":{"seo":{"title":"Retrieve event details","description":"Retrieve details of the current revision of the requested event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_event","name":"Retrieve event details","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve event details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of the current revision of the requested event\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/events/{event}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/events/{event}","href":"managing-events/retrieve_event","openApiOperationId":"retrieve_event","summary":"Retrieve event details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the current revision of the requested event were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"An event with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/retrieve_event"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}"},{"label":"Update event details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/update_event","routeSlug":"/openapi/managing-events/update_event","metadata":{"seo":{"title":"Update event details","description":"Change the details of the current revision of the requested event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event","name":"Update event details","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update event details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the details of the current revision of the requested event\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hosts/{host}/events/{event}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404"],"pointer":"/hosts/{host}/events/{event}","href":"managing-events/update_event","openApiOperationId":"update_event","summary":"Update event details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-5","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The details of the current revision of the specified event were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"An event with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-11","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/update_event"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}"},{"label":"Remove an event","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/delete_event","routeSlug":"/openapi/managing-events/delete_event","metadata":{"seo":{"title":"Remove an event","description":"Completely remove a registered event from the system. Only events that have not sold any tickets can be deleted. If tickets have been sold, but further sales should be prevented, an event can be unpublished or cancelled as necessary."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_event","name":"Remove an event","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove a registered event from the system. Only events that have not sold\nany tickets can be deleted. If tickets have been sold, but further sales should be\nprevented, an event can be unpublished or cancelled as necessary.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hosts/{host}/events/{event}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404","409"],"pointer":"/hosts/{host}/events/{event}","href":"managing-events/delete_event","openApiOperationId":"delete_event","summary":"Remove an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"An event with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Tickets for this event have already been sold.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/delete_event"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}"},{"label":"List event submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/list_event_submissions","routeSlug":"/openapi/managing-events/list_event_submissions","metadata":{"seo":{"title":"List event submissions","description":"Retrieve a list of event changes submitted for review."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_submissions","name":"List event submissions","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of event changes submitted for review.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/events/{event}/submissions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/events/{event}/submissions","href":"managing-events/list_event_submissions","openApiOperationId":"list_event_submissions","summary":"List event submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of previously submitted event revisions was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_62","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_62","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/list_event_submissions"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}/submissions"},{"label":"Submit event for review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/submit_event","routeSlug":"/openapi/managing-events/submit_event","metadata":{"seo":{"title":"Submit event for review","description":"Submit the current event revision for administrative review. All revisions to an event listing must be reviewd and approved before being published and made available to the public."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submit_event","name":"Submit event for review","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit event for review","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit the current event revision for administrative review. All revisions to an event listing\nmust be reviewd and approved before being published and made available to the public.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-6","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-6","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hosts/{host}/events/{event}/submissions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-6","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409"],"pointer":"/hosts/{host}/events/{event}/submissions","href":"managing-events/submit_event","openApiOperationId":"submit_event","summary":"Submit event for review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-6","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-6","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The current event revision was successfully submitted for review.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-12","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-12","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/403/content/application~1json/example"]},{"code":"409","description":"Pending changes have already been submitted for review, and are awaiting approval.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-12","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-12","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/submit_event"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}/submissions"},{"label":"List event publications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/list_event_publications","routeSlug":"/openapi/managing-events/list_event_publications","metadata":{"seo":{"title":"List event publications","description":"Retrieve a list of published revisions for this event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_publications","name":"List event publications","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event publications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of published revisions for this event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/events/{event}/publications","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/events/{event}/publications","href":"managing-events/list_event_publications","openApiOperationId":"list_event_publications","summary":"List event publications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of previously published event revisions was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_63","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_63","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/list_event_publications"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}/publications"},{"label":"Publish event changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-events/publish_event","routeSlug":"/openapi/managing-events/publish_event","metadata":{"seo":{"title":"Publish event changes","description":"Publish the current revision to an event's listing. Once a revision is published, an event becomes publically visible. If this is not the first published revision, the event's listing is overriden with the revised changes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"publish_event","name":"Publish event changes","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish event changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Publish the current revision to an event's listing. Once a revision is published, an\nevent becomes publically visible. If this is not the first published revision, the event's\nlisting is overriden with the revised changes.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-7","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-7","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hosts/{host}/events/{event}/publications","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-7","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409"],"pointer":"/hosts/{host}/events/{event}/publications","href":"managing-events/publish_event","openApiOperationId":"publish_event","summary":"Publish event changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-7","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-7","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The current event revision was successfully published.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-13","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-13","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/403/content/application~1json/example"]},{"code":"409","description":"Changes must be submitted and approved before they can be published.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-13","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-13","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-events/publish_event"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}/publications"}],"content":{"contentType":"group","meta":{"name":"Managing Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managing Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hosts/{host}/events","summary":"List events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-events/list_host_events","deprecated":false},{"title":"/hosts/{host}/events","summary":"Register an event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managing-events/register_event","deprecated":false},{"title":"/hosts/{host}/events/{event}","summary":"Retrieve event details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-events/retrieve_event","deprecated":false},{"title":"/hosts/{host}/events/{event}","summary":"Update event details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/managing-events/update_event","deprecated":false},{"title":"/hosts/{host}/events/{event}","summary":"Remove an event","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/managing-events/delete_event","deprecated":false},{"title":"/hosts/{host}/events/{event}/submissions","summary":"List event submissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-events/list_event_submissions","deprecated":false},{"title":"/hosts/{host}/events/{event}/submissions","summary":"Submit event for review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managing-events/submit_event","deprecated":false},{"title":"/hosts/{host}/events/{event}/publications","summary":"List event publications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-events/list_event_publications","deprecated":false},{"title":"/hosts/{host}/events/{event}/publications","summary":"Publish event changes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managing-events/publish_event","deprecated":false}]}]}]}]}},{"type":"group","label":"Managing Tiers","link":"/openapi/managing-tiers","routeSlug":"/openapi/managing-tiers","items":[{"label":"List tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/list_host_tiers","routeSlug":"/openapi/managing-tiers/list_host_tiers","metadata":{"seo":{"title":"List tiers","description":"Retrieve a list of all ticket tiers managed by the specified host."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_host_tiers","name":"List tiers","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1tiers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tiers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all ticket tiers managed by the specified host.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1tiers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"event","in":"query","schemaId":"schema_54","description":"If set, only returns tiers with the specified event in their bundle"}],"pointer":"/paths/~1hosts~1{host}~1tiers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/tiers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"event","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/tiers","href":"managing-tiers/list_host_tiers","openApiOperationId":"list_host_tiers","summary":"List tiers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of managed tiers was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_64","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1tiers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_64","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-tiers/list_host_tiers"}],"panels":[]}]},"httpPath":"/hosts/{host}/tiers"},{"label":"Create a tier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/create_tier","routeSlug":"/openapi/managing-tiers/create_tier","metadata":{"seo":{"title":"Create a tier","description":"Create a new tier for selling tickets to a registered event. Tiers define the price points a which tickets are to be sold, and metadata about how tickets issued under the tier should behave. Tiers can manage ticket sales for a single event, or a bundle of related events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_tier","name":"Create a tier","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1tiers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new tier for selling tickets to a registered event. Tiers define\nthe price points a which tickets are to be sold, and metadata about how tickets issued\nunder the tier should behave. Tiers can manage ticket sales for a single event, or a\nbundle of related events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1tiers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1tiers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hosts/{host}/tiers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409"],"pointer":"/hosts/{host}/tiers","href":"managing-tiers/create_tier","openApiOperationId":"create_tier","summary":"Create a tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The new tier was successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/201/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available_to and available_from dates are inconsistent, bundle shares do not total to 100 or one or more upgrade tiers do not have events in common."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/403/content/application~1json/example"]},{"code":"409","description":"One or more of the specified events already has a tier with the given name.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1tiers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-tiers/create_tier"}],"panels":[]}]},"httpPath":"/hosts/{host}/tiers"},{"label":"Retrieve tier details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/retrieve_tier","routeSlug":"/openapi/managing-tiers/retrieve_tier","metadata":{"seo":{"title":"Retrieve tier details","description":"Retrieve full details of the requested tier"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_tier","name":"Retrieve tier details","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve tier details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve full details of the requested tier\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"tier","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested tier","required":true}],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/tiers/{tier}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"tier","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/tiers/{tier}","href":"managing-tiers/retrieve_tier","openApiOperationId":"retrieve_tier","summary":"Retrieve tier details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Full details of the requested tier were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"A tier with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-tiers/retrieve_tier"}],"panels":[]}]},"httpPath":"/hosts/{host}/tiers/{tier}"},{"label":"Update tier details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/update_tier","routeSlug":"/openapi/managing-tiers/update_tier","metadata":{"seo":{"title":"Update tier details","description":"Change the details of the requested tier. Only tiers for which no tickets have been sold can be changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_tier","name":"Update tier details","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tier details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the details of the requested tier. Only tiers for which no tickets have\nbeen sold can be changed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"tier","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested tier","required":true}],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hosts/{host}/tiers/{tier}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"tier","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404","409"],"pointer":"/hosts/{host}/tiers/{tier}","href":"managing-tiers/update_tier","openApiOperationId":"update_tier","summary":"Update tier details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-8","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The details of the specified tier were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The available_to and available_from dates are inconsistent, bundle shares do not total to 100 or one or more upgrade tiers do not have events in common."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/400/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"A tier with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/404/content/application~1json/example"]},{"code":"409","description":"Tickets have already been issued under this tier and changes or deletion are no longer possible.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-14","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-tiers/update_tier"}],"panels":[]}]},"httpPath":"/hosts/{host}/tiers/{tier}"},{"label":"Remove a tier","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/managing-tiers/delete_tier","routeSlug":"/openapi/managing-tiers/delete_tier","metadata":{"seo":{"title":"Remove a tier","description":"Completely remove a tier from the system. Only tiers for which no tickets have been sold can be deleted. If tickets have been sold, but further sales should be prevented, a tier can be expired."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_tier","name":"Remove a tier","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a tier","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove a tier from the system. Only tiers for which no tickets have\nbeen sold can be deleted. If tickets have been sold, but further sales should be\nprevented, a tier can be expired.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"tier","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested tier","required":true}],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hosts/{host}/tiers/{tier}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"tier","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404","409"],"pointer":"/hosts/{host}/tiers/{tier}","href":"managing-tiers/delete_tier","openApiOperationId":"delete_tier","summary":"Remove a tier"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tier was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"A tier with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Tickets have already been issued under this tier and changes or deletion are no longer possible.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managing-tiers/delete_tier"}],"panels":[]}]},"httpPath":"/hosts/{host}/tiers/{tier}"}],"content":{"contentType":"group","meta":{"name":"Managing Tiers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managing Tiers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hosts/{host}/tiers","summary":"List tiers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-tiers/list_host_tiers","deprecated":false},{"title":"/hosts/{host}/tiers","summary":"Create a tier","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managing-tiers/create_tier","deprecated":false},{"title":"/hosts/{host}/tiers/{tier}","summary":"Retrieve tier details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/managing-tiers/retrieve_tier","deprecated":false},{"title":"/hosts/{host}/tiers/{tier}","summary":"Update tier details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/managing-tiers/update_tier","deprecated":false},{"title":"/hosts/{host}/tiers/{tier}","summary":"Remove a tier","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/managing-tiers/delete_tier","deprecated":false}]}]}]}]}},{"type":"group","label":"Event Listings","link":"/openapi/event-listings","routeSlug":"/openapi/event-listings","items":[{"label":"List all published events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-listings/list_published_events","routeSlug":"/openapi/event-listings/list_published_events","metadata":{"seo":{"title":"List all published events","description":"Retrieve a list of published events that match the given criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_published_events","name":"List all published events","isWebhook":false,"pointer":"/paths/~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all published events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of published events that match the given criteria.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"region","in":"query","schemaId":"schema_54","description":"If set, only returns events being hosted in the specified region"},{"name":"host","in":"query","schemaId":"schema_54","description":"If set, only returns events being staged by the specified host"},{"name":"title","in":"query","schemaId":"schema_44","description":"If set, only returns events whose title matches the specified regular expression"},{"name":"active","in":"query","schemaId":"schema_50","description":"Only returns future events if set to true, or past events if set to false"},{"name":"category","in":"query","schemaId":"schema_44","description":"If set, only returns events belonging to the specified category"},{"name":"subcategory","in":"query","schemaId":"schema_44","description":"If set, only returns events belonging to the specified subcategory"},{"name":"featured","in":"query","schemaId":"schema_50","description":"Only returns featured events if set to true, or non-featured events if set to false."},{"name":"sort","in":"query","schemaId":"schema_51","description":"If set, determines how the returned events list is sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"region","in":"query","required":false,"schemaId":"schema_54"},{"name":"host","in":"query","required":false,"schemaId":"schema_54"},{"name":"title","in":"query","required":false,"schemaId":"schema_44"},{"name":"active","in":"query","required":false,"schemaId":"schema_50"},{"name":"category","in":"query","required":false,"schemaId":"schema_44"},{"name":"subcategory","in":"query","required":false,"schemaId":"schema_44"},{"name":"featured","in":"query","required":false,"schemaId":"schema_50"},{"name":"sort","in":"query","required":false,"schemaId":"schema_51"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/events","href":"event-listings/list_published_events","openApiOperationId":"list_published_events","summary":"List all published events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of published events was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1events/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_53","exampleIds":["paths/~1events/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_53","exampleIds":["paths/~1events/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1events/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-listings/list_published_events"}],"panels":[]}]},"httpPath":"/events"},{"label":"Retrieve event listing","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-listings/retrieve_published_event","routeSlug":"/openapi/event-listings/retrieve_published_event","metadata":{"seo":{"title":"Retrieve event listing","description":"Retrieve the registration details of the requested event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_published_event","name":"Retrieve event listing","isWebhook":false,"pointer":"/paths/~1events~1{event}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve event listing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the registration details of the requested event\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{event}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/events/{event}","href":"event-listings/retrieve_published_event","openApiOperationId":"retrieve_published_event","summary":"Retrieve event listing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested event were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-9","exampleIds":["paths/~1events~1{event}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-9","exampleIds":["paths/~1events~1{event}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access to unlisted events is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"An event with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-9","exampleIds":["paths/~1events~1{event}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-9","exampleIds":["paths/~1events~1{event}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-listings/retrieve_published_event"}],"panels":[]}]},"httpPath":"/events/{event}"},{"label":"List event tiers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-listings/list_event_tiers","routeSlug":"/openapi/event-listings/list_event_tiers","metadata":{"seo":{"title":"List event tiers","description":"Retrieve a list of all ticket tiers associated with the specified event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_tiers","name":"List event tiers","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tiers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event tiers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all ticket tiers associated with the specified event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}~1tiers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"active","in":"query","schemaId":"schema_50","description":"Only returns tiers available for sale if true, or unavailable tiers if false"}],"pointer":"/paths/~1events~1{event}~1tiers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{event}/tiers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"active","in":"query","required":false,"schemaId":"schema_50"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/events/{event}/tiers","href":"event-listings/list_event_tiers","openApiOperationId":"list_event_tiers","summary":"List event tiers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of tiers associated with the event was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_65","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Access to unlisted events is forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tiers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tiers/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-listings/list_event_tiers"}],"panels":[]}]},"httpPath":"/events/{event}/tiers"}],"content":{"contentType":"group","meta":{"name":"Event Listings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Listings","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"List all published events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-listings/list_published_events","deprecated":false},{"title":"/events/{event}","summary":"Retrieve event listing","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-listings/retrieve_published_event","deprecated":false},{"title":"/events/{event}/tiers","summary":"List event tiers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-listings/list_event_tiers","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales Reporting","link":"/openapi/sales-reporting","routeSlug":"/openapi/sales-reporting","items":[{"label":"List host sales","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/list_host_sales","routeSlug":"/openapi/sales-reporting/list_host_sales","metadata":{"seo":{"title":"List host sales","description":"Retrieve a list of all recorded sales for the specified host."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_host_sales","name":"List host sales","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1sales/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List host sales","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all recorded sales for the specified host.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1sales/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_66","description":"Only return sales transacted on or after the specified date and time"},{"name":"before","in":"query","schemaId":"schema_66","description":"Only return sales transacted on or before the specified date and time"},{"name":"event","in":"query","schemaId":"schema_54","description":"Only return sales of tiers associated with the specified event"},{"name":"tier","in":"query","schemaId":"schema_54","description":"Only return sales of the specified tier"},{"name":"number","in":"query","schemaId":"schema_44","description":"Only return sales associated with the specified order"},{"name":"customer","in":"query","schemaId":"schema_44","description":"Only return sales generated by the specified customer"},{"name":"status","in":"query","schemaId":"schema_67","description":"Only return sales with the specified status"},{"name":"sort","in":"query","schemaId":"schema_68","description":"If set, determines how the returned sales list is sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1hosts~1{host}~1sales/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/sales","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"after","in":"query","required":false,"schemaId":"schema_66"},{"name":"before","in":"query","required":false,"schemaId":"schema_66"},{"name":"event","in":"query","required":false,"schemaId":"schema_54"},{"name":"tier","in":"query","required":false,"schemaId":"schema_54"},{"name":"number","in":"query","required":false,"schemaId":"schema_44"},{"name":"customer","in":"query","required":false,"schemaId":"schema_44"},{"name":"status","in":"query","required":false,"schemaId":"schema_67"},{"name":"sort","in":"query","required":false,"schemaId":"schema_68"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/sales","href":"sales-reporting/list_host_sales","openApiOperationId":"list_host_sales","summary":"List host sales"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of recorded sales was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified host or its resources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1sales/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1sales/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-reporting/list_host_sales"}],"panels":[]}]},"httpPath":"/hosts/{host}/sales"},{"label":"Retrieve host statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/retrieve_host_statistics","routeSlug":"/openapi/sales-reporting/retrieve_host_statistics","metadata":{"seo":{"title":"Retrieve host statistics","description":"Retrieve aggregated statistics for a host including total revenue and tickets sold."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_host_statistics","name":"Retrieve host statistics","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1statistics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve host statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve aggregated statistics for a host including total revenue and tickets sold.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true}],"pointer":"/paths/~1hosts~1{host}~1statistics/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_66","description":"Only aggregate statistics for activity after the specified date"},{"name":"before","in":"query","schemaId":"schema_66","description":"Only aggregate statistics for activity before the specified date"},{"name":"interval","in":"query","schemaId":"schema_70","description":"The time intervals over to breakdown aggregated statistics"}],"pointer":"/paths/~1hosts~1{host}~1statistics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/statistics","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"after","in":"query","required":false,"schemaId":"schema_66"},{"name":"before","in":"query","required":false,"schemaId":"schema_66"},{"name":"interval","in":"query","required":false,"schemaId":"schema_70"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/hosts/{host}/statistics","href":"sales-reporting/retrieve_host_statistics","openApiOperationId":"retrieve_host_statistics","summary":"Retrieve host statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The host statistics resource was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested resource could not be located","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1statistics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1statistics/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-reporting/retrieve_host_statistics"}],"panels":[]}]},"httpPath":"/hosts/{host}/statistics"},{"label":"List event sales","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/list_event_sales","routeSlug":"/openapi/sales-reporting/list_event_sales","metadata":{"seo":{"title":"List event sales","description":"Retrieve a list of all recorded sales for the specified event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_sales","name":"List event sales","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1sales/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event sales","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of all recorded sales for the specified event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1sales/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_66","description":"Only return sales transacted on or after the specified date and time"},{"name":"before","in":"query","schemaId":"schema_66","description":"Only return sales transacted on or before the specified date and time"},{"name":"tier","in":"query","schemaId":"schema_54","description":"Only return sales of the specified tier"},{"name":"number","in":"query","schemaId":"schema_44","description":"Only return sales associated with the specified order"},{"name":"customer","in":"query","schemaId":"schema_44","description":"Only return sales generated by the specified customer"},{"name":"status","in":"query","schemaId":"schema_67","description":"Only return sales with the specified status"},{"name":"sort","in":"query","schemaId":"schema_68","description":"If set, determines how the returned sales list is sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1sales/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/events/{event}/sales","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"after","in":"query","required":false,"schemaId":"schema_66"},{"name":"before","in":"query","required":false,"schemaId":"schema_66"},{"name":"tier","in":"query","required":false,"schemaId":"schema_54"},{"name":"number","in":"query","required":false,"schemaId":"schema_44"},{"name":"customer","in":"query","required":false,"schemaId":"schema_44"},{"name":"status","in":"query","required":false,"schemaId":"schema_67"},{"name":"sort","in":"query","required":false,"schemaId":"schema_68"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","404"],"pointer":"/hosts/{host}/events/{event}/sales","href":"sales-reporting/list_event_sales","openApiOperationId":"list_event_sales","summary":"List event sales"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of recorded sales was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The requesting user is not authorised to perform this operation on the specified event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-reporting/list_event_sales"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}/sales"},{"label":"Retrieve event statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sales-reporting/retrieve_event_statistics","routeSlug":"/openapi/sales-reporting/retrieve_event_statistics","metadata":{"seo":{"title":"Retrieve event statistics","description":"Retrieve aggregated statistics for an event including total revenue and tickets sold."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_event_statistics","name":"Retrieve event statistics","isWebhook":false,"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1statistics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve event statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve aggregated statistics for an event including total revenue and tickets sold.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"host","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested host","required":true},{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1statistics/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_66","description":"Only return sales transacted on or after the specified date and time"},{"name":"before","in":"query","schemaId":"schema_66","description":"Only return sales transacted on or before the specified date and time"},{"name":"interval","in":"query","schemaId":"schema_70","description":"The time intervals over to breakdown aggregated statistics"}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1statistics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hosts/{host}/events/{event}/statistics","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"host","in":"path","required":true,"schemaId":"schema_41"},{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"after","in":"query","required":false,"schemaId":"schema_66"},{"name":"before","in":"query","required":false,"schemaId":"schema_66"},{"name":"interval","in":"query","required":false,"schemaId":"schema_70"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/hosts/{host}/events/{event}/statistics","href":"sales-reporting/retrieve_event_statistics","openApiOperationId":"retrieve_event_statistics","summary":"Retrieve event statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event statistics resource was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested resource could not be located","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-17","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sales-reporting/retrieve_event_statistics"}],"panels":[]}]},"httpPath":"/hosts/{host}/events/{event}/statistics"}],"content":{"contentType":"group","meta":{"name":"Sales Reporting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales Reporting","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hosts/{host}/sales","summary":"List host sales","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-reporting/list_host_sales","deprecated":false},{"title":"/hosts/{host}/statistics","summary":"Retrieve host statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-reporting/retrieve_host_statistics","deprecated":false},{"title":"/hosts/{host}/events/{event}/sales","summary":"List event sales","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-reporting/list_event_sales","deprecated":false},{"title":"/hosts/{host}/events/{event}/statistics","summary":"Retrieve event statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales-reporting/retrieve_event_statistics","deprecated":false}]}]}]}]}},{"type":"group","label":"Event Admissions","link":"/openapi/event-admissions","routeSlug":"/openapi/event-admissions","items":[{"label":"Issue admission tokens","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/manage_admission_tokens","routeSlug":"/openapi/event-admissions/manage_admission_tokens","metadata":{"seo":{"title":"Issue admission tokens","description":"Create tokens that authorise event staff to grant admission to the event. Tokens allow event staff to redeem tickets and admit patrons to one or more event sections. Each event has a global token that allows redemption of tickets for all sections. Additional tokens can be created, as needed, and should be issued to event staff on a one-to-one basis."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"manage_admission_tokens","name":"Issue admission tokens","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tokens/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue admission tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create tokens that authorise event staff to grant admission to the event. Tokens allow event staff to redeem tickets\nand admit patrons to one or more event sections. Each event has a global token that allows redemption of tickets for\nall sections. Additional tokens can be created, as needed, and should be issued to event staff on a one-to-one basis.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}~1tokens/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1events~1{event}~1tokens/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events/{event}/tokens","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400"],"pointer":"/events/{event}/tokens","href":"event-admissions/manage_admission_tokens","openApiOperationId":"manage_admission_tokens","summary":"Issue admission tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The admission token was successfully added to the event\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/201/content/application~1json/example"]},{"code":"400","description":"One or more of the specified sections does not belong to this event","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tokens/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/post/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/manage_admission_tokens"}],"panels":[]}]},"httpPath":"/events/{event}/tokens"},{"label":"List admission tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/list_event_tokens","routeSlug":"/openapi/event-admissions/list_event_tokens","metadata":{"seo":{"title":"List admission tokens","description":"Retrieve a list of tokens permitted to redeem tickets issued for this event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_tokens","name":"List admission tokens","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tokens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List admission tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of tokens permitted to redeem tickets issued for this event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}~1tokens/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"global","in":"query","schemaId":"schema_50","description":"Only returns the global token if true, all additional tokens if false."}],"pointer":"/paths/~1events~1{event}~1tokens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{event}/tokens","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"global","in":"query","required":false,"schemaId":"schema_50"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","404"],"pointer":"/events/{event}/tokens","href":"event-admissions/list_event_tokens","openApiOperationId":"list_event_tokens","summary":"List admission tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of event tokens matching the given criteria was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_71","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tokens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_71","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/list_event_tokens"}],"panels":[]}]},"httpPath":"/events/{event}/tokens"},{"label":"Retrieve admission token details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/retrieve_admission_token","routeSlug":"/openapi/event-admissions/retrieve_admission_token","metadata":{"seo":{"title":"Retrieve admission token details","description":"Retrieve the details of the specified admission token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_admission_token","name":"Retrieve admission token details","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tokens~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve admission token details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the specified admission token.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true},{"name":"token","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested admission token","required":true}],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{event}/tokens/{token}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"},{"name":"token","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","404"],"pointer":"/events/{event}/tokens/{token}","href":"event-admissions/retrieve_admission_token","openApiOperationId":"retrieve_admission_token","summary":"Retrieve admission token details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested adnussion token were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested resource could not be located","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/retrieve_admission_token"}],"panels":[]}]},"httpPath":"/events/{event}/tokens/{token}"},{"label":"Modify admission token sections","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/update_admission_token","routeSlug":"/openapi/event-admissions/update_admission_token","metadata":{"seo":{"title":"Modify admission token sections","description":"Update the event sections that the admission token can be used to grant entry to"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_admission_token","name":"Modify admission token sections","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tokens~1{token}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify admission token sections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the event sections that the admission token can be used to grant entry to\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true},{"name":"token","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested admission token","required":true}],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/events/{event}/tokens/{token}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"},{"name":"token","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","409"],"pointer":"/events/{event}/tokens/{token}","href":"event-admissions/update_admission_token","openApiOperationId":"update_admission_token","summary":"Modify admission token sections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-9","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The admission tokens associated sections were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"One or more of the specified sections does not belong to this event","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/400/content/application~1json/example"]},{"code":"409","description":"The global admission token cannot be modified or deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-18","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/update_admission_token"}],"panels":[]}]},"httpPath":"/events/{event}/tokens/{token}"},{"label":"Invalidate an admission token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/invalidate_admission_token","routeSlug":"/openapi/event-admissions/invalidate_admission_token","metadata":{"seo":{"title":"Invalidate an admission token","description":"Invalidate an admission token and remove it from the event. Invalidated tokens can no longer be used by event staff to redeem tickets and grant admission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invalidate_admission_token","name":"Invalidate an admission token","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tokens~1{token}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invalidate an admission token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Invalidate an admission token and remove it from the event. Invalidated tokens can no longer be used\nby event staff to redeem tickets and grant admission.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true},{"name":"token","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested admission token","required":true}],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/events/{event}/tokens/{token}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"},{"name":"token","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","409"],"pointer":"/events/{event}/tokens/{token}","href":"event-admissions/invalidate_admission_token","openApiOperationId":"invalidate_admission_token","summary":"Invalidate an admission token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The admission token was successfully invalidated and removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/200/content/application~1json/example"]},{"code":"409","description":"The global admission token cannot be modified or deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tokens~1{token}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/200/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tokens~1{token}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/invalidate_admission_token"}],"panels":[]}]},"httpPath":"/events/{event}/tokens/{token}"},{"label":"Retrieve valid event tickets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/list_event_tickets","routeSlug":"/openapi/event-admissions/list_event_tickets","metadata":{"seo":{"title":"Retrieve valid event tickets","description":"Retrieve a detailed list of valid event tickets issued for sections that the authenticated redeemer is authorised to admit patrons to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_tickets","name":"Retrieve valid event tickets","isWebhook":false,"pointer":"/paths/~1events~1{event}~1tickets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve valid event tickets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a detailed list of valid event tickets issued for sections that the authenticated redeemer\nis authorised to admit patrons to.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["redeemer"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}~1tickets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"modified_since","in":"query","schemaId":"schema_66","description":"Only return tickets that have had a status change after the provided date"}],"pointer":"/paths/~1events~1{event}~1tickets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{event}/tickets","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"modified_since","in":"query","required":false,"schemaId":"schema_66"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["redeemer"]}],"responseCodes":["200","403","404"],"pointer":"/events/{event}/tickets","href":"event-admissions/list_event_tickets","openApiOperationId":"list_event_tickets","summary":"Retrieve valid event tickets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of matching tickets the authenticated redeemer has access to was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_72","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to redeem tickets for any section of this event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1tickets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_72","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1tickets/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/list_event_tickets"}],"panels":[]}]},"httpPath":"/events/{event}/tickets"},{"label":"Admit event patrons","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/admit_event_patrons","routeSlug":"/openapi/event-admissions/admit_event_patrons","metadata":{"seo":{"title":"Admit event patrons","description":"Attempt to admit one or more patrons to an event based on their ticket serial numbers. The endpoint accepts a list containing the serials of tickets to be redeemed. The system will admit any serials that are currently valid for the event sections that the redeemer is authorised to admit to, and return a list of those that were successfully redeemed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"admit_event_patrons","name":"Admit event patrons","isWebhook":false,"pointer":"/paths/~1events~1{event}~1admissions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Admit event patrons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Attempt to admit one or more patrons to an event based on their ticket serial numbers.\nThe endpoint accepts a list containing the serials of tickets to be redeemed. The system\nwill admit any serials that are currently valid for the event sections that the redeemer is\nauthorised to admit to, and return a list of those that were successfully redeemed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["redeemer"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}~1admissions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-10","exampleIds":["paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-10","exampleIds":["paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1events~1{event}~1admissions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/events/{event}/admissions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["redeemer"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-10","exampleIds":["paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403"],"pointer":"/events/{event}/admissions","href":"event-admissions/admit_event_patrons","openApiOperationId":"admit_event_patrons","summary":"Admit event patrons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-10","exampleIds":["paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-10","exampleIds":["paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"One or more of the tickets identified by the provided serials grants admission to an \nauthorised event section and have been successfully redeemed.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/collection","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/201/content/application~1json/example"]},{"code":"400","description":"None of the tickets identified grants access to an event section that the redeemer\nis allowed to admit patrons to. This is either because no ticket could be found,\nthe tickets grant access to different event sections or the tickets have already\nbeen redeemed or expired.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to redeem tickets for any section of this event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1admissions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/collection","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/admit_event_patrons"}],"panels":[]}]},"httpPath":"/events/{event}/admissions"},{"label":"List event admissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/event-admissions/list_event_admissions","routeSlug":"/openapi/event-admissions/list_event_admissions","metadata":{"seo":{"title":"List event admissions","description":"Retrieve a list of admissions to the event sections that the authenticated redeemer has access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_admissions","name":"List event admissions","isWebhook":false,"pointer":"/paths/~1events~1{event}~1admissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event admissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of admissions to the event sections that the authenticated redeemer has access to.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"event","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event","required":true}],"pointer":"/paths/~1events~1{event}~1admissions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"redeemer","in":"query","schemaId":"schema_44","description":"Only return admissions granted on tickets redeemed by the specified name."},{"name":"device","in":"query","schemaId":"schema_44","description":"Only return admissions granted on tickets redeemed by the specified device."},{"name":"ticket","in":"query","schemaId":"schema_73","description":"Only return details of the admission granted by the specified ticket"},{"name":"patron","in":"query","schemaId":"schema_74","description":"Only return admissions of the specified patron to the event"},{"name":"section","in":"query","schemaId":"schema_54","description":"Only return admissions to the specified section of this event"}],"pointer":"/paths/~1events~1{event}~1admissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{event}/admissions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"event","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"redeemer","in":"query","required":false,"schemaId":"schema_44"},{"name":"device","in":"query","required":false,"schemaId":"schema_44"},{"name":"ticket","in":"query","required":false,"schemaId":"schema_73"},{"name":"patron","in":"query","required":false,"schemaId":"schema_74"},{"name":"section","in":"query","required":false,"schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","403","404"],"pointer":"/events/{event}/admissions","href":"event-admissions/list_event_admissions","openApiOperationId":"list_event_admissions","summary":"List event admissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of event admissions matching the given criteria was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_75","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to redeem tickets for any section of this event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1events~1{event}~1admissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_75","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1events~1{event}~1admissions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/event-admissions/list_event_admissions"}],"panels":[]}]},"httpPath":"/events/{event}/admissions"}],"content":{"contentType":"group","meta":{"name":"Event Admissions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event Admissions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events/{event}/tokens","summary":"Issue admission tokens","prefix":{"name":"post","color":"post"},"badges":[],"link":"/event-admissions/manage_admission_tokens","deprecated":false},{"title":"/events/{event}/tokens","summary":"List admission tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-admissions/list_event_tokens","deprecated":false},{"title":"/events/{event}/tokens/{token}","summary":"Retrieve admission token details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-admissions/retrieve_admission_token","deprecated":false},{"title":"/events/{event}/tokens/{token}","summary":"Modify admission token sections","prefix":{"name":"put","color":"put"},"badges":[],"link":"/event-admissions/update_admission_token","deprecated":false},{"title":"/events/{event}/tokens/{token}","summary":"Invalidate an admission token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/event-admissions/invalidate_admission_token","deprecated":false},{"title":"/events/{event}/tickets","summary":"Retrieve valid event tickets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-admissions/list_event_tickets","deprecated":false},{"title":"/events/{event}/admissions","summary":"Admit event patrons","prefix":{"name":"post","color":"post"},"badges":[],"link":"/event-admissions/admit_event_patrons","deprecated":false},{"title":"/events/{event}/admissions","summary":"List event admissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/event-admissions/list_event_admissions","deprecated":false}]}]}]}]}},{"type":"separator","label":"Purchasing Tickets","content":null},{"type":"group","label":"Ordering Tickets","link":"/openapi/ordering-tickets","routeSlug":"/openapi/ordering-tickets","items":[{"label":"List customer orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/list_customer_orders","routeSlug":"/openapi/ordering-tickets/list_customer_orders","metadata":{"seo":{"title":"List customer orders","description":"List customer orders matching the specified search criteria"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_orders","name":"List customer orders","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List customer orders matching the specified search criteria\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1orders/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"number","in":"query","schemaId":"schema_44","description":"If set, only returns orders whose number matches the specified regular expression"},{"name":"status","in":"query","schemaId":"schema_76","description":"If set, only returns orders with the specified status"},{"name":"sort","in":"query","schemaId":"schema_77","description":"If set, determines how the returned orders are sorted"},{"name":"order","in":"query","schemaId":"schema_52","description":"If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order."}],"pointer":"/paths/~1accounts~1{number}~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/orders","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"number","in":"query","required":false,"schemaId":"schema_44"},{"name":"status","in":"query","required":false,"schemaId":"schema_76"},{"name":"sort","in":"query","required":false,"schemaId":"schema_77"},{"name":"order","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/accounts/{number}/orders","href":"ordering-tickets/list_customer_orders","openApiOperationId":"list_customer_orders","summary":"List customer orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of matching customer orders was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_78","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_78","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ordering-tickets/list_customer_orders"}],"panels":[]}]},"httpPath":"/accounts/{number}/orders"},{"label":"Place a new order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/place_order","routeSlug":"/openapi/ordering-tickets/place_order","metadata":{"seo":{"title":"Place a new order","description":"Place a new order for one or more tickets. A single order can include multipleticket types of a single event, or from multiple events. When a new order is createdtickets are reserved for a fixed period of time until the order is settled, cancelledor times out."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"place_order","name":"Place a new order","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Place a new order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Place a new order for one or more tickets. A single order can include multiple"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ticket types of a single event, or from multiple events. When a new order is created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tickets are reserved for a fixed period of time until the order is settled, cancelled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or times out."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the tickets being ordered are free (i.e. the order total is $0.00), the order is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fuliflled immediately and tickets delivered to the customer's account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true}],"pointer":"/paths/~1accounts~1{number}~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-11","exampleIds":["paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-11","exampleIds":["paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{number}~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts/{number}/orders","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-11","exampleIds":["paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409"],"pointer":"/accounts/{number}/orders","href":"ordering-tickets/place_order","openApiOperationId":"place_order","summary":"Place a new order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-11","exampleIds":["paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-11","exampleIds":["paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The order was successfully placed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/201/content/application~1json/example"]},{"code":"400","description":"One or more of the specified tiers do not exist, have insufficient availability or are complimentary, or the requested ticket amount exceeds a tier's purchase limit.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access orders on behalf of the ordering customer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/403/content/application~1json/example"]},{"code":"409","description":"Tiers attached to one or more unpublished events cannot be purchased.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ordering-tickets/place_order"}],"panels":[]}]},"httpPath":"/accounts/{number}/orders"},{"label":"Retrieve order details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/retrieve_order","routeSlug":"/openapi/ordering-tickets/retrieve_order","metadata":{"seo":{"title":"Retrieve order details","description":"Retrieve the details of the requested order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_order","name":"Retrieve order details","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1orders~1{order}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve order details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the requested order\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true},{"name":"order","in":"path","schemaId":"schema_54","description":"Unique identifier of the order"}],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{number}/orders/{order}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"},{"name":"order","in":"path","required":false,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403"],"pointer":"/accounts/{number}/orders/{order}","href":"ordering-tickets/retrieve_order","openApiOperationId":"retrieve_order","summary":"Retrieve order details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested order were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access orders on behalf of the ordering customer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-21","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ordering-tickets/retrieve_order"}],"panels":[]}]},"httpPath":"/accounts/{number}/orders/{order}"},{"label":"Cancel an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/cancel_order","routeSlug":"/openapi/ordering-tickets/cancel_order","metadata":{"seo":{"title":"Cancel an order","description":"Cancel an existing order. Any reserved tickets are immediately released. An order can only be cancelled if it has not already been settled or timed out."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_order","name":"Cancel an order","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1orders~1{order}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel an existing order. Any reserved tickets are immediately released. An order\ncan only be cancelled if it has not already been settled or timed out.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true},{"name":"order","in":"path","schemaId":"schema_54","description":"Unique identifier of the order"}],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accounts/{number}/orders/{order}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"},{"name":"order","in":"path","required":false,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","409"],"pointer":"/accounts/{number}/orders/{order}","href":"ordering-tickets/cancel_order","openApiOperationId":"cancel_order","summary":"Cancel an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order was successfully cancelled.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to access orders on behalf of the ordering customer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/403/content/application~1json/example"]},{"code":"409","description":"The order has already been settled or timed out and so can't be cancelled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ordering-tickets/cancel_order"}],"panels":[]}]},"httpPath":"/accounts/{number}/orders/{order}"},{"label":"Attempt payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ordering-tickets/settle_order","routeSlug":"/openapi/ordering-tickets/settle_order","metadata":{"seo":{"title":"Attempt payment","description":"Attempt to settle a pending order by credit card payment. Payment can only be attemptedonce an order has been placed, but before it has timed out or been cancelled. Payment canno longer be attempted once an order has been fulfilled, refunded or cancelled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settle_order","name":"Attempt payment","isWebhook":false,"pointer":"/paths/~1accounts~1{number}~1orders~1{order}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attempt payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempt to settle a pending order by credit card payment. Payment can only be attempted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"once an order has been placed, but before it has timed out or been cancelled. Payment can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no longer be attempted once an order has been fulfilled, refunded or cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the tickets being ordered are free (i.e. the order total is $0.00), the order does"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not require settlement, and will be fulfilled immediately without payment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number","in":"path","schemaId":"schema_44","description":"Alphanumeric identifier of the user account","required":true},{"name":"order","in":"path","schemaId":"schema_54","description":"Unique identifier of the order"}],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-12","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-12","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accounts/{number}/orders/{order}/payments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"number","in":"path","required":true,"schemaId":"schema_44"},{"name":"order","in":"path","required":false,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-12","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409"],"pointer":"/accounts/{number}/orders/{order}/payments","href":"ordering-tickets/settle_order","openApiOperationId":"settle_order","summary":"Attempt payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-12","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-12","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Payment was accepted in settlement of the order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-22","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-22","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Required payment information was missing or provided details were invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not authorised to make payment on behalf of the ordering customer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/403/content/application~1json/example"]},{"code":"409","description":"Payment was attempted on a fulfilled, timed out, refunded or cancelled order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-22","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-22","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ordering-tickets/settle_order"}],"panels":[]}]},"httpPath":"/accounts/{number}/orders/{order}/payments"}],"content":{"contentType":"group","meta":{"name":"Ordering Tickets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ordering Tickets","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accounts/{number}/orders","summary":"List customer orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ordering-tickets/list_customer_orders","deprecated":false},{"title":"/accounts/{number}/orders","summary":"Place a new order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ordering-tickets/place_order","deprecated":false},{"title":"/accounts/{number}/orders/{order}","summary":"Retrieve order details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ordering-tickets/retrieve_order","deprecated":false},{"title":"/accounts/{number}/orders/{order}","summary":"Cancel an order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ordering-tickets/cancel_order","deprecated":false},{"title":"/accounts/{number}/orders/{order}/payments","summary":"Attempt payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ordering-tickets/settle_order","deprecated":false}]}]}]}]}},{"type":"separator","label":"Managing Tickets","content":null},{"type":"group","label":"Ticket Transfers","link":"/openapi/ticket-transfers","routeSlug":"/openapi/ticket-transfers","items":[{"label":"Initiating a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/initiate_transfer","routeSlug":"/openapi/ticket-transfers/initiate_transfer","metadata":{"seo":{"title":"Initiating a transfer","description":"Initiate a transfer of one or more tickets from the requesting user to another TickeTing user. Initiating a transfer, does not automatically move tickets between accounts, but instead sends a transfer request. This request must first be claimed at which time the tickets themselves are transferred. If the transfer request is cancelled or rejected, no tickets change hands."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiate_transfer","name":"Initiating a transfer","isWebhook":false,"pointer":"/paths/~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiating a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiate a transfer of one or more tickets from the requesting user\nto another TickeTing user. Initiating a transfer, does not automatically\nmove tickets between accounts, but instead sends a transfer request. This request\nmust first be claimed at which time the tickets themselves are transferred.\nIf the transfer request is cancelled or rejected, no tickets change hands.\n\nOne or more tickets, for one or multiple events, can be sent in a single transfer. \nTickets that are part of an open transfer (not yet claimed, canclled or rejected)\nenter into a pending state in which they cannot be redeemed, only becoming usable\nagain once a decision is taken on the transfer.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-13","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-13","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-13","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","404","409"],"pointer":"/transfers","href":"ticket-transfers/initiate_transfer","openApiOperationId":"initiate_transfer","summary":"Initiating a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-13","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-13","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The transfer was successfully initiated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/example"]},{"code":"400","description":"One or more of the specified sections do not exist or the sender does not own sufficient tickets to complete the transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not permitted to initiate transfers on behalf of the sender.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The specified sender or recipient does not exist in the system.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/example"]},{"code":"409","description":"The sender attempted to transfer tickets to themselves.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-transfers/initiate_transfer"}],"panels":[]}]},"httpPath":"/transfers"},{"label":"Retrieve transfer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/retrieve_transfer","routeSlug":"/openapi/ticket-transfers/retrieve_transfer","metadata":{"seo":{"title":"Retrieve transfer details","description":"Retrieve the details of the requested transfer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_transfer","name":"Retrieve transfer details","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve transfer details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the requested transfer\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer","in":"path","schemaId":"schema_54","description":"Unique identifier of the transfer"}],"pointer":"/paths/~1transfers~1{transfer}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transfer}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"transfer","in":"path","required":false,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403"],"pointer":"/transfers/{transfer}","href":"ticket-transfers/retrieve_transfer","openApiOperationId":"retrieve_transfer","summary":"Retrieve transfer details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested transfer were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers~1{transfer}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers~1{transfer}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not permitted to initiate transfers on behalf of the sender.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/get/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1transfers~1{transfer}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers~1{transfer}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-10","exampleIds":["paths/~1transfers~1{transfer}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/get/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-transfers/retrieve_transfer"}],"panels":[]}]},"httpPath":"/transfers/{transfer}"},{"label":"Cancel a transfer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/cancel_transfer","routeSlug":"/openapi/ticket-transfers/cancel_transfer","metadata":{"seo":{"title":"Cancel a transfer","description":"Cancel a pending transfer. A transfer can be cancelled by either its sender or its recipient before it is claimed. Any pending tickets attached to the transfer are immediately released. A transfer can only be cancelled if it has not yet been claimed, or previously cancelled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_transfer","name":"Cancel a transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel a pending transfer. A transfer can be cancelled by either its sender or\nits recipient before it is claimed. Any pending tickets attached to the transfer\nare immediately released. A transfer can only be cancelled if it has not yet\nbeen claimed, or previously cancelled.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer","in":"path","schemaId":"schema_54","description":"Unique identifier of the transfer"}],"pointer":"/paths/~1transfers~1{transfer}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transfers/{transfer}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"transfer","in":"path","required":false,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","403","409"],"pointer":"/transfers/{transfer}","href":"ticket-transfers/cancel_transfer","openApiOperationId":"cancel_transfer","summary":"Cancel a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The transfer was successfully cancelled.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not permitted to initiate transfers on behalf of the sender.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/403/content/application~1json/example"]},{"code":"409","description":"The transfer has already been claimed or cancelled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1transfers~1{transfer}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-transfers/cancel_transfer"}],"panels":[]}]},"httpPath":"/transfers/{transfer}"},{"label":"Claim a transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ticket-transfers/claim_transfer","routeSlug":"/openapi/ticket-transfers/claim_transfer","metadata":{"seo":{"title":"Claim a transfer","description":"Claim a pending transfer. Once claimed, any tickets attached to the transfer are moved from the sender's account to the recipient's and returned to a usable state. Only a transfer's recipient can claim a transfer, and a transfer can no longer be claimed once it has been cancelled or claimed previously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"claim_transfer","name":"Claim a transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer}~1claims/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Claim a transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Claim a pending transfer. Once claimed, any tickets attached to the transfer are moved\nfrom the sender's account to the recipient's and returned to a usable state. Only a\ntransfer's recipient can claim a transfer, and a transfer can no longer be claimed once\nit has been cancelled or claimed previously.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer","in":"path","schemaId":"schema_54","description":"Unique identifier of the transfer"}],"pointer":"/paths/~1transfers~1{transfer}~1claims/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers/{transfer}/claims","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"transfer","in":"path","required":false,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["201","403","409"],"pointer":"/transfers/{transfer}/claims","href":"ticket-transfers/claim_transfer","openApiOperationId":"claim_transfer","summary":"Claim a transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The transferred tickets were successfully delivered to the recipient's account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-23","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-23","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/201/content/application~1json/example"]},{"code":"403","description":"The authenticating user is not the recipient of this transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/403/content/application~1json/example"]},{"code":"409","description":"An attempt was made to claim a cancelled or previously claimed transfer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1transfers~1{transfer}~1claims/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-23","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-23","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1transfers~1{transfer}~1claims/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticket-transfers/claim_transfer"}],"panels":[]}]},"httpPath":"/transfers/{transfer}/claims"}],"content":{"contentType":"group","meta":{"name":"Ticket Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Transfers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfers","summary":"Initiating a transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-transfers/initiate_transfer","deprecated":false},{"title":"/transfers/{transfer}","summary":"Retrieve transfer details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticket-transfers/retrieve_transfer","deprecated":false},{"title":"/transfers/{transfer}","summary":"Cancel a transfer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ticket-transfers/cancel_transfer","deprecated":false},{"title":"/transfers/{transfer}/claims","summary":"Claim a transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticket-transfers/claim_transfer","deprecated":false}]}]}]}]}},{"type":"separator","label":"System Administration","content":null},{"type":"group","label":"Region Management","link":"/openapi/region-management","routeSlug":"/openapi/region-management","items":[{"label":"List supported regions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/list_regions","routeSlug":"/openapi/region-management/list_regions","metadata":{"seo":{"title":"List supported regions","description":"Retrieve a list of supported regions where events can be staged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_regions","name":"List supported regions","isWebhook":false,"pointer":"/paths/~1regions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List supported regions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of supported regions where events can be staged.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"active","in":"query","schemaId":"schema_50","description":"Returns regions with one or more upcoming events, if true, or regions without upcoming events if false."}],"pointer":"/paths/~1regions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/regions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"active","in":"query","required":false,"schemaId":"schema_50"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/regions","href":"region-management/list_regions","openApiOperationId":"list_regions","summary":"List supported regions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of supported regions was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1regions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_79","exampleIds":["paths/~1regions/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1regions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_79","exampleIds":["paths/~1regions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1regions/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1regions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-management/list_regions"}],"panels":[]}]},"httpPath":"/regions"},{"label":"Add a supported region","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/add_region","routeSlug":"/openapi/region-management/add_region","metadata":{"seo":{"title":"Add a supported region","description":"Add a supported region to the TickeTing system. Any venue created needs to reference the region in which it is located. Events staged at this venue will be grouped within the related region, and are displayed to users based on their regional preference."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"add_region","name":"Add a supported region","isWebhook":false,"pointer":"/paths/~1regions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a supported region","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a supported region to the TickeTing system. Any venue created needs to reference the region\nin which it is located. Events staged at this venue will be grouped within the related region,\nand are displayed to users based on their regional preference.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1regions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/regions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","409"],"pointer":"/regions","href":"region-management/add_region","openApiOperationId":"add_region","summary":"Add a supported region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The supported region was successfully added.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/400/content/application~1json/example"]},{"code":"409","description":"The provided name is already in use by another region","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1regions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-management/add_region"}],"panels":[]}]},"httpPath":"/regions"},{"label":"Retrieve region details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/retrieve_region","routeSlug":"/openapi/region-management/retrieve_region","metadata":{"seo":{"title":"Retrieve region details","description":"Retrieve the details of the specified region."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_region","name":"Retrieve region details","isWebhook":false,"pointer":"/paths/~1regions~1{region}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve region details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the specified region.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"region","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested region","required":true}],"pointer":"/paths/~1regions~1{region}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/regions/{region}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"region","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/regions/{region}","href":"region-management/retrieve_region","openApiOperationId":"retrieve_region","summary":"Retrieve region details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested region were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"A region with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1regions~1{region}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-management/retrieve_region"}],"panels":[]}]},"httpPath":"/regions/{region}"},{"label":"Modify region details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/update_region","routeSlug":"/openapi/region-management/update_region","metadata":{"seo":{"title":"Modify region details","description":"Update the details of the specified region"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_region","name":"Modify region details","isWebhook":false,"pointer":"/paths/~1regions~1{region}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify region details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of the specified region\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"region","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested region","required":true}],"pointer":"/paths/~1regions~1{region}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions~1{region}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions~1{region}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1regions~1{region}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/regions/{region}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"region","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions~1{region}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","409"],"pointer":"/regions/{region}","href":"region-management/update_region","openApiOperationId":"update_region","summary":"Modify region details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions~1{region}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-14","exampleIds":["paths/~1regions~1{region}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The region's details were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/400/content/application~1json/example"]},{"code":"409","description":"The provided name is already in use by another region","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1regions~1{region}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-6","exampleIds":["paths/~1regions~1{region}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-management/update_region"}],"panels":[]}]},"httpPath":"/regions/{region}"},{"label":"Remove a supported region","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/region-management/remove_region","routeSlug":"/openapi/region-management/remove_region","metadata":{"seo":{"title":"Remove a supported region","description":"Completely remove a supported region from the system. A region can only be deleted if it has no venues associated to it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove_region","name":"Remove a supported region","isWebhook":false,"pointer":"/paths/~1regions~1{region}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a supported region","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove a supported region from the system. A region can only be deleted\nif it has no venues associated to it.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"region","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested region","required":true}],"pointer":"/paths/~1regions~1{region}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/regions/{region}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"region","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","409"],"pointer":"/regions/{region}","href":"region-management/remove_region","openApiOperationId":"remove_region","summary":"Remove a supported region"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The suported region was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/200/content/application~1json/example"]},{"code":"409","description":"The region currently contains one or more venus.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1regions~1{region}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/200/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1regions~1{region}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/region-management/remove_region"}],"panels":[]}]},"httpPath":"/regions/{region}"}],"content":{"contentType":"group","meta":{"name":"Region Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Region Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/regions","summary":"List supported regions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/region-management/list_regions","deprecated":false},{"title":"/regions","summary":"Add a supported region","prefix":{"name":"post","color":"post"},"badges":[],"link":"/region-management/add_region","deprecated":false},{"title":"/regions/{region}","summary":"Retrieve region details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/region-management/retrieve_region","deprecated":false},{"title":"/regions/{region}","summary":"Modify region details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/region-management/update_region","deprecated":false},{"title":"/regions/{region}","summary":"Remove a supported region","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/region-management/remove_region","deprecated":false}]}]}]}]}},{"type":"group","label":"Venue Management","link":"/openapi/venue-management","routeSlug":"/openapi/venue-management","items":[{"label":"List event venues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/list_venues","routeSlug":"/openapi/venue-management/list_venues","metadata":{"seo":{"title":"List event venues","description":"Retrieve a list of approved venues at which events can be hosted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_venues","name":"List event venues","isWebhook":false,"pointer":"/paths/~1venues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event venues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of approved venues at which events can be hosted.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"region","in":"query","schemaId":"schema_54","description":"If set, only returns venues located in the specified region"},{"name":"name","in":"query","schemaId":"schema_44","description":"If set, only returns venues whose name matches the specified regular expression"}],"pointer":"/paths/~1venues/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/venues","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"region","in":"query","required":false,"schemaId":"schema_54"},{"name":"name","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/venues","href":"venue-management/list_venues","openApiOperationId":"list_venues","summary":"List event venues"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of event venues was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1venues/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1venues/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1venues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_80","exampleIds":["paths/~1venues/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1venues/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1venues/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/venue-management/list_venues"}],"panels":[]}]},"httpPath":"/venues"},{"label":"Create an event venue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/create_venue","routeSlug":"/openapi/venue-management/create_venue","metadata":{"seo":{"title":"Create an event venue","description":"Create an approved venue that can stage events. Once created, the venue can be selected as hosting new events added to the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_venue","name":"Create an event venue","isWebhook":false,"pointer":"/paths/~1venues/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an event venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an approved venue that can stage events. Once created, the venue can be\nselected as hosting new events added to the system.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1venues/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/venues","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","409"],"pointer":"/venues","href":"venue-management/create_venue","openApiOperationId":"create_venue","summary":"Create an event venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The new venue was successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/400/content/application~1json/example"]},{"code":"409","description":"The provided name is already in use by another venue in this region","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1venues/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/venue-management/create_venue"}],"panels":[]}]},"httpPath":"/venues"},{"label":"Retrieve event venue details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/retrieve_venue","routeSlug":"/openapi/venue-management/retrieve_venue","metadata":{"seo":{"title":"Retrieve event venue details","description":"Retrieve the details of the specified event venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_venue","name":"Retrieve event venue details","isWebhook":false,"pointer":"/paths/~1venues~1{venue}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve event venue details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the specified event venue.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venue","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event venue","required":true}],"pointer":"/paths/~1venues~1{venue}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/venues/{venue}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"venue","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/venues/{venue}","href":"venue-management/retrieve_venue","openApiOperationId":"retrieve_venue","summary":"Retrieve event venue details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested event venue were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"A venue with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1venues~1{venue}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/venue-management/retrieve_venue"}],"panels":[]}]},"httpPath":"/venues/{venue}"},{"label":"Modify event venue details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/update_venue","routeSlug":"/openapi/venue-management/update_venue","metadata":{"seo":{"title":"Modify event venue details","description":"Update the details of the specified event venue"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_venue","name":"Modify event venue details","isWebhook":false,"pointer":"/paths/~1venues~1{venue}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify event venue details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of the specified event venue\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venue","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event venue","required":true}],"pointer":"/paths/~1venues~1{venue}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues~1{venue}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues~1{venue}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1venues~1{venue}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/venues/{venue}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"venue","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues~1{venue}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","409"],"pointer":"/venues/{venue}","href":"venue-management/update_venue","openApiOperationId":"update_venue","summary":"Modify event venue details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues~1{venue}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-15","exampleIds":["paths/~1venues~1{venue}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event venue's details were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/400/content/application~1json/example"]},{"code":"409","description":"The provided name is already in use by another venue in this region","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1venues~1{venue}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-7","exampleIds":["paths/~1venues~1{venue}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/venue-management/update_venue"}],"panels":[]}]},"httpPath":"/venues/{venue}"},{"label":"Remove an event venue","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/venue-management/delete_venue","routeSlug":"/openapi/venue-management/delete_venue","metadata":{"seo":{"title":"Remove an event venue","description":"Completely remove an event venue from the system. A venue can only be deleted if no events are or have been staged there."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_venue","name":"Remove an event venue","isWebhook":false,"pointer":"/paths/~1venues~1{venue}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an event venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove an event venue from the system. A venue can only be deleted\nif no events are or have been staged there.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venue","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event venue","required":true}],"pointer":"/paths/~1venues~1{venue}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/venues/{venue}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"venue","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","409"],"pointer":"/venues/{venue}","href":"venue-management/delete_venue","openApiOperationId":"delete_venue","summary":"Remove an event venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event venue was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/200/content/application~1json/example"]},{"code":"409","description":"The venue is currently hosting, or has staged, one or more event.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1venues~1{venue}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/200/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1venues~1{venue}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/venue-management/delete_venue"}],"panels":[]}]},"httpPath":"/venues/{venue}"}],"content":{"contentType":"group","meta":{"name":"Venue Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Venue Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/venues","summary":"List event venues","prefix":{"name":"get","color":"get"},"badges":[],"link":"/venue-management/list_venues","deprecated":false},{"title":"/venues","summary":"Create an event venue","prefix":{"name":"post","color":"post"},"badges":[],"link":"/venue-management/create_venue","deprecated":false},{"title":"/venues/{venue}","summary":"Retrieve event venue details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/venue-management/retrieve_venue","deprecated":false},{"title":"/venues/{venue}","summary":"Modify event venue details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/venue-management/update_venue","deprecated":false},{"title":"/venues/{venue}","summary":"Remove an event venue","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/venue-management/delete_venue","deprecated":false}]}]}]}]}},{"type":"group","label":"Category Management","link":"/openapi/category-management","routeSlug":"/openapi/category-management","items":[{"label":"List event categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/list_categories","routeSlug":"/openapi/category-management/list_categories","metadata":{"seo":{"title":"List event categories","description":"Retrieve a list of event categories under which events can be classified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_categories","name":"List event categories","isWebhook":false,"pointer":"/paths/~1categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of event categories under which events can be classified.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"}],"pointer":"/paths/~1categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/categories","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/categories","href":"category-management/list_categories","openApiOperationId":"list_categories","summary":"List event categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of event categories was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81","exampleIds":["paths/~1categories/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_81","exampleIds":["paths/~1categories/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_81","exampleIds":["paths/~1categories/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81","exampleIds":["paths/~1categories/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1categories/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/category-management/list_categories"}],"panels":[]}]},"httpPath":"/categories"},{"label":"Create an event category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/create_category","routeSlug":"/openapi/category-management/create_category","metadata":{"seo":{"title":"Create an event category","description":"Create an event category (and its associated subcategories). Once created, the category (and one of its subcategories) can be used to classify events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_category","name":"Create an event category","isWebhook":false,"pointer":"/paths/~1categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an event category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an event category (and its associated subcategories). Once created, the category \n(and one of its subcategories) can be used to classify events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/categories","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","409"],"pointer":"/categories","href":"category-management/create_category","openApiOperationId":"create_category","summary":"Create an event category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The new category was successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories/post/responses/201/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/example"]},{"code":"409","description":"An event category with the specified name already exists in the system.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/category-management/create_category"}],"panels":[]}]},"httpPath":"/categories"},{"label":"Retrieve category details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/retrieve_category","routeSlug":"/openapi/category-management/retrieve_category","metadata":{"seo":{"title":"Retrieve category details","description":"Retrieve the details of the specified event category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_category","name":"Retrieve category details","isWebhook":false,"pointer":"/paths/~1categories~1{category}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve category details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the specified event category.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"category","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event category","required":true}],"pointer":"/paths/~1categories~1{category}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/categories/{category}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"category","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/categories/{category}","href":"category-management/retrieve_category","openApiOperationId":"retrieve_category","summary":"Retrieve category details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested event category were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested resource could not be located","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1categories~1{category}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/category-management/retrieve_category"}],"panels":[]}]},"httpPath":"/categories/{category}"},{"label":"Modify category details","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/update_category","routeSlug":"/openapi/category-management/update_category","metadata":{"seo":{"title":"Modify category details","description":"Update the details of the specified event category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_category","name":"Modify category details","isWebhook":false,"pointer":"/paths/~1categories~1{category}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify category details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the details of the specified event category\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"category","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event category","required":true}],"pointer":"/paths/~1categories~1{category}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories~1{category}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories~1{category}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1categories~1{category}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/categories/{category}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"category","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories~1{category}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","409"],"pointer":"/categories/{category}","href":"category-management/update_category","openApiOperationId":"update_category","summary":"Modify category details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories~1{category}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-16","exampleIds":["paths/~1categories~1{category}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event category's details were successfully updated.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/400/content/application~1json/example"]},{"code":"409","description":"An event category with the specified name already exists in the system.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1categories~1{category}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-8","exampleIds":["paths/~1categories~1{category}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/put/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/category-management/update_category"}],"panels":[]}]},"httpPath":"/categories/{category}"},{"label":"Remove a category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/category-management/delete_category","routeSlug":"/openapi/category-management/delete_category","metadata":{"seo":{"title":"Remove a category","description":"Completely remove an event category from the system. A category can only be deleted if it is not associated with any events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_category","name":"Remove a category","isWebhook":false,"pointer":"/paths/~1categories~1{category}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely remove an event category from the system. A category can only be deleted\nif it is not associated with any events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"category","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested event category","required":true}],"pointer":"/paths/~1categories~1{category}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/categories/{category}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"category","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","409"],"pointer":"/categories/{category}","href":"category-management/delete_category","openApiOperationId":"delete_category","summary":"Remove a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The event category was successfully removed from the system.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/200/content/application~1json/example"]},{"code":"409","description":"One or more events are currently listed under this category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1categories~1{category}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/200/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1categories~1{category}/delete/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/category-management/delete_category"}],"panels":[]}]},"httpPath":"/categories/{category}"}],"content":{"contentType":"group","meta":{"name":"Category Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Category Management","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/categories","summary":"List event categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/category-management/list_categories","deprecated":false},{"title":"/categories","summary":"Create an event category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/category-management/create_category","deprecated":false},{"title":"/categories/{category}","summary":"Retrieve category details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/category-management/retrieve_category","deprecated":false},{"title":"/categories/{category}","summary":"Modify category details","prefix":{"name":"put","color":"put"},"badges":[],"link":"/category-management/update_category","deprecated":false},{"title":"/categories/{category}","summary":"Remove a category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/category-management/delete_category","deprecated":false}]}]}]}]}},{"type":"group","label":"Reviewing Content","link":"/openapi/reviewing-content","routeSlug":"/openapi/reviewing-content","items":[{"label":"List submissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/list_submissions","routeSlug":"/openapi/reviewing-content/list_submissions","metadata":{"seo":{"title":"List submissions","description":"Retrieve a list of content submitted for administrative review and publising approval."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_submissions","name":"List submissions","isWebhook":false,"pointer":"/paths/~1submissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List submissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of content submitted for administrative review and publising approval.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"records","in":"query","schemaId":"schema_42","description":"The number of records per page that should be returned"},{"name":"page","in":"query","schemaId":"schema_43","description":"The number of the results page to return"},{"name":"type","in":"query","schemaId":"schema_44","description":"If set, only returns submissions of the specified content type."},{"name":"status","in":"query","schemaId":"schema_44","description":"If set, only returns submissions with the specified status."}],"pointer":"/paths/~1submissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/submissions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[{"name":"records","in":"query","required":false,"schemaId":"schema_42"},{"name":"page","in":"query","required":false,"schemaId":"schema_43"},{"name":"type","in":"query","required":false,"schemaId":"schema_44"},{"name":"status","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","404"],"pointer":"/submissions","href":"reviewing-content/list_submissions","openApiOperationId":"list_submissions","summary":"List submissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of content submissions was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1submissions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_62","exampleIds":["paths/~1submissions/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested results page does not exist for the number of records specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1submissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_62","exampleIds":["paths/~1submissions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1submissions/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1submissions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviewing-content/list_submissions"}],"panels":[]}]},"httpPath":"/submissions"},{"label":"Retrieve submission details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/retrieve_submission","routeSlug":"/openapi/reviewing-content/retrieve_submission","metadata":{"seo":{"title":"Retrieve submission details","description":"Retrieve the details of the specified content submission"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_submission","name":"Retrieve submission details","isWebhook":false,"pointer":"/paths/~1submissions~1{submission}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve submission details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of the specified content submission\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"submission","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested submission","required":true}],"pointer":"/paths/~1submissions~1{submission}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/submissions/{submission}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"submission","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","404"],"pointer":"/submissions/{submission}","href":"reviewing-content/retrieve_submission","openApiOperationId":"retrieve_submission","summary":"Retrieve submission details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the requested content submission were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-12","exampleIds":["paths/~1submissions~1{submission}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-12","exampleIds":["paths/~1submissions~1{submission}/get/responses/200/content/application~1json/example"]},{"code":"404","description":"A submission with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1submissions~1{submission}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-12","exampleIds":["paths/~1submissions~1{submission}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-12","exampleIds":["paths/~1submissions~1{submission}/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviewing-content/retrieve_submission"}],"panels":[]}]},"httpPath":"/submissions/{submission}"},{"label":"Retrieve submission decision","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/retrieve_submission_decision","routeSlug":"/openapi/reviewing-content/retrieve_submission_decision","metadata":{"seo":{"title":"Retrieve submission decision","description":"Retrieve details of the decision taken on a submission, if one exists"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_submission_decision","name":"Retrieve submission decision","isWebhook":false,"pointer":"/paths/~1submissions~1{submission}~1decision/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve submission decision","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of the decision taken on a submission, if one exists\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"submission","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested submission","required":true}],"pointer":"/paths/~1submissions~1{submission}~1decision/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/submissions/{submission}/decision","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"submission","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"responseCodes":["200","404"],"pointer":"/submissions/{submission}/decision","href":"reviewing-content/retrieve_submission_decision","openApiOperationId":"retrieve_submission_decision","summary":"Retrieve submission decision"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the submission's decision were successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/200/content/application~1json/example"]},{"code":"404","description":"A decision has not yet been taken on this submission.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1submissions~1{submission}~1decision/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviewing-content/retrieve_submission_decision"}],"panels":[]}]},"httpPath":"/submissions/{submission}/decision"},{"label":"Decide on a submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reviewing-content/take_submission_decision","routeSlug":"/openapi/reviewing-content/take_submission_decision","metadata":{"seo":{"title":"Decide on a submission","description":"Take a decision (approve/reject) on the content submission"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"take_submission_decision","name":"Decide on a submission","isWebhook":false,"pointer":"/paths/~1submissions~1{submission}~1decision/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decide on a submission","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Take a decision (approve/reject) on the content submission\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"submission","in":"path","schemaId":"schema_41","description":"Unique identifier of the requested submission","required":true}],"pointer":"/paths/~1submissions~1{submission}~1decision/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-17","exampleIds":["paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/request-17","exampleIds":["paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1submissions~1{submission}~1decision/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/submissions/{submission}/decision","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[{"name":"submission","in":"path","required":true,"schemaId":"schema_41"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["administrator"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/request-17","exampleIds":["paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","409"],"pointer":"/submissions/{submission}/decision","href":"reviewing-content/take_submission_decision","openApiOperationId":"take_submission_decision","summary":"Decide on a submission"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"schemaId":"components/schemas/request-17","exampleIds":["paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/request-17","exampleIds":["paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The decision was successfully taken on the specified submission.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/200/content/application~1json/example"]},{"code":"400","description":"The request payload is invalid JSON or has missing, malformed or incorrect attributes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/400/content/application~1json/example"]},{"code":"404","description":"A submission with the given URI does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/404/content/application~1json/example"]},{"code":"409","description":"A decision has already been taken on this submission.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/409/content/application~1json/example"]}],"pointer":"/paths/~1submissions~1{submission}~1decision/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/response-24","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1submissions~1{submission}~1decision/post/responses/409/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviewing-content/take_submission_decision"}],"panels":[]}]},"httpPath":"/submissions/{submission}/decision"}],"content":{"contentType":"group","meta":{"name":"Reviewing Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviewing Content","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/submissions","summary":"List submissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviewing-content/list_submissions","deprecated":false},{"title":"/submissions/{submission}","summary":"Retrieve submission details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviewing-content/retrieve_submission","deprecated":false},{"title":"/submissions/{submission}/decision","summary":"Retrieve submission decision","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviewing-content/retrieve_submission_decision","deprecated":false},{"title":"/submissions/{submission}/decision","summary":"Decide on a submission","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reviewing-content/take_submission_decision","deprecated":false}]}]}]}]}},{"type":"group","label":"Default Values","link":"/openapi/default-values","routeSlug":"/openapi/default-values","items":[{"label":"Retrieve a list of countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/default-values/retrieve_countries","routeSlug":"/openapi/default-values/retrieve_countries","metadata":{"seo":{"title":"Retrieve a list of countries","description":"Retrieve a list of country names to be used in association with user accounts, events, hosts, etc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve_countries","name":"Retrieve a list of countries","isWebhook":false,"pointer":"/paths/~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of country names to be used in association with\nuser accounts, events, hosts, etc.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SessionKey","scopes":["public","customer","administrator"],"type":"apiKey","in":"header","paramName":"X-API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/countries","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SessionKey","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":["public","customer","administrator"]}],"responseCodes":["200","404"],"pointer":"/countries","href":"default-values/retrieve_countries","openApiOperationId":"retrieve_countries","summary":"Retrieve a list of countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of country names was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/countries","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/countries","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"]},{"code":"404","description":"The requested resource could not be located","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1countries/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/message","exampleIds":["paths/~1countries/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/countries","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/countries","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/message","exampleIds":["paths/~1countries/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/message","exampleIds":["paths/~1countries/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/default-values/retrieve_countries"}],"panels":[]}]},"httpPath":"/countries"}],"content":{"contentType":"group","meta":{"name":"Default Values"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Default Values","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/countries","summary":"Retrieve a list of countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/default-values/retrieve_countries","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/credentials":{"id":"components/schemas/credentials","kind":"json-schema","title":"credentials","data":{"type":"object","required":["identification","password"],"properties":{"identification":{"type":"string","description":"The username or email address of the account starting the session"},"password":{"type":"string","format":"password","description":"The password of the account starting the session"}}}},"components/schemas/response":{"id":"components/schemas/response","kind":"json-schema","title":"response","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the session resource"},"id":{"type":"integer","description":"Unique ID number of the session resource"},"open":{"type":"boolean","description":"True if the session is currently active, false otherwise"},"started":{"type":"string","format":"date-time","description":"Time at which the session was created"},"key":{"type":"string","description":"The key associated to this session resource. Include this token in the\n'X-API-Key' Header to authenticate requests as the associated user account\n"},"account":{"type":"object","description":"User account for which the session was opened","properties":{"self":{"type":"string","description":"URI of the account resource"},"number":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{8}$","description":"Immutable identifier attached to the account"},"username":{"type":"string","description":"Unique username attached to the account"},"email":{"type":"string","format":"email","description":"Unique email address attached to the account"},"role":{"type":"string","enum":["customer","support","host","administrator"],"description":"User role assigned to the account"},"verified":{"type":"boolean","description":"True if the account email address has been verified, false otherwise"},"activated":{"type":"boolean","description":"True if the account is active, false if it has been deactivated"},"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"},"title":{"type":"string","enum":["Mr","Mrs","Ms","Mx"],"description":"The account holder's formal title"},"dateOfBirth":{"type":"string","format":"date","description":"The account holder's date of birth"},"phone":{"type":"string","format":"phone","description":"The account holder's primary contact number"},"country":{"type":"string","description":"The country associated with the account (used for regionalisation)"},"firstAddressLine":{"type":"string","description":"The first line of the account holder's address"},"secondAddressLine":{"type":"string","description":"The second line of the account holder's address"},"city":{"type":"string","description":"The city portion of the account holder's address"},"state":{"type":"string","description":"The state, parish or district portion of the account holder's address"},"preferences":{"type":"string","description":"URI of the account's user preferences resource"}},"unevaluatedProperties":true}}}},"components/schemas/message":{"id":"components/schemas/message","kind":"json-schema","title":"message","data":{"type":"object","properties":{"message":{"type":"string","description":"Reason for the given response."}}}},"components/schemas/token":{"id":"components/schemas/token","kind":"json-schema","title":"token","data":{"type":"object","properties":{"key":{"type":"string","description":"The API access key associated with this token"},"event":{"type":"string","format":"uri","description":"URI of the event resource the token belongs to"},"sections":{"type":"array","description":"List of sections this token can redeem tickets for.","items":{"type":"string","format":"uri","description":"URI of the event section resource"}}}}},"components/schemas/request":{"id":"components/schemas/request","kind":"json-schema","title":"request","data":{"type":"object","required":["name","access"],"properties":{"name":{"type":"string","description":"Unique name of the API Integration Token"},"access":{"type":"string","enum":["public","customer","support","host","administrator"],"description":"The required access level for this token"}}}},"components/schemas/response-2":{"id":"components/schemas/response-2","kind":"json-schema","title":"response-2","data":{"type":"object","properties":{"name":{"type":"string","description":"Unique name of the API Integration Token"},"access":{"type":"string","enum":["public","customer","support","host","administrator"],"description":"The required access level for this token"},"key":{"type":"string","description":"The unique API Key attached to this integration. Can be used\nto authenticate API requests with the specified access level.\n"}}}},"components/schemas/results":{"id":"components/schemas/results","kind":"json-schema","title":"results","data":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results available"},"page":{"type":"integer","description":"The number of the results page returned"},"records":{"type":"integer","description":"The maximum number of results returned per page"}}}},"components/schemas/response-3":{"id":"components/schemas/response-3","kind":"json-schema","title":"response-3","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the account resource"},"number":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{8}$","description":"Immutable identifier attached to the account"},"username":{"type":"string","description":"Unique username attached to the account"},"email":{"type":"string","format":"email","description":"Unique email address attached to the account"},"role":{"type":"string","enum":["customer","support","host","administrator"],"description":"User role assigned to the account"},"verified":{"type":"boolean","description":"True if the account email address has been verified, false otherwise"},"activated":{"type":"boolean","description":"True if the account is active, false if it has been deactivated"},"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"},"title":{"type":"string","enum":["Mr","Mrs","Ms","Mx"],"description":"The account holder's formal title"},"dateOfBirth":{"type":"string","format":"date","description":"The account holder's date of birth"},"phone":{"type":"string","format":"phone","description":"The account holder's primary contact number"},"country":{"type":"string","description":"The country associated with the account (used for regionalisation)"},"firstAddressLine":{"type":"string","description":"The first line of the account holder's address"},"secondAddressLine":{"type":"string","description":"The second line of the account holder's address"},"city":{"type":"string","description":"The city portion of the account holder's address"},"state":{"type":"string","description":"The state, parish or district portion of the account holder's address"},"preferences":{"type":"string","description":"URI of the account's user preferences resource"}}}},"components/schemas/list":{"id":"components/schemas/list","kind":"json-schema","title":"list","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-3"}}}}},"components/schemas/request-2":{"id":"components/schemas/request-2","kind":"json-schema","title":"request-2","data":{"type":"object","required":["username","password","email"],"properties":{"username":{"type":"string","description":"Unique username attached to the account"},"password":{"type":"string","format":"password","description":"The password of the account starting the session"},"email":{"type":"string","format":"email","description":"Unique email address attached to the account"},"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"},"title":{"type":"string","enum":["Mr","Mrs","Ms","Mx"],"description":"The account holder's formal title"},"dateOfBirth":{"type":"string","format":"date","description":"The account holder's date of birth"},"phone":{"type":"string","format":"phone","description":"The account holder's primary contact number"},"country":{"type":"string","description":"The country associated with the account (used for regionalisation)"},"firstAddressLine":{"type":"string","description":"The first line of the account holder's address"},"secondAddressLine":{"type":"string","description":"The second line of the account holder's address"},"city":{"type":"string","description":"The city portion of the account holder's address"},"state":{"type":"string","description":"The state, parish or district portion of the account holder's address"}}}},"components/schemas/update":{"id":"components/schemas/update","kind":"json-schema","title":"update","data":{"type":"object","properties":{"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"},"title":{"type":"string","enum":["Mr","Mrs","Ms","Mx"],"description":"The account holder's formal title"},"dateOfBirth":{"type":"string","format":"date","description":"The account holder's date of birth"},"phone":{"type":"string","format":"phone","description":"The account holder's primary contact number"},"country":{"type":"string","description":"The country associated with the account (used for regionalisation)"},"firstAddressLine":{"type":"string","description":"The first line of the account holder's address"},"secondAddressLine":{"type":"string","description":"The second line of the account holder's address"},"city":{"type":"string","description":"The city portion of the account holder's address"},"state":{"type":"string","description":"The state, parish or district portion of the account holder's address"}}}},"components/schemas/preferences":{"id":"components/schemas/preferences","kind":"json-schema","title":"preferences","data":{"type":"object","required":["region"],"properties":{"region":{"type":"string","description":"The user's preferred region. Events and advertisements from the\nselected region will be shown by default.\n"}}}},"components/schemas/response-4":{"id":"components/schemas/response-4","kind":"json-schema","title":"response-4","data":{"type":"object","required":["self","user","role","type","resource","pending"],"properties":{"self":{"type":"string","description":"URI of the privilege resource."},"user":{"type":"string","format":"email","description":"Email adddress of the user to which this privilege belongs."},"role":{"type":"object","description":"The role assigned to the specified user by this privilege.","properties":{"name":{"type":"string","description":"The name of the assigned role"},"permissions":{"type":"array","description":"The list of permissions this role confers to the user.","items":{"type":"string"}}}},"type":{"description":"Resource type to which this privilege grants access.","type":"string","enum":["Host","Event"]},"resource":{"description":"Unique identifier of the resource to which this privilege grants access.","type":"string","pattern":"^[0-9]{14}$"},"pending":{"type":"boolean","description":"True if the privileged user needs to signup for a TickeTing account, false if not."}}}},"components/schemas/list-2":{"id":"components/schemas/list-2","kind":"json-schema","title":"list-2","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-4"}}}}},"components/schemas/response-5":{"id":"components/schemas/response-5","kind":"json-schema","title":"response-5","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the host resource"},"name":{"type":"string","description":"Unique name of the event host"},"contact":{"type":"string","description":"First and last name of the event host's primary contact person"},"email":{"type":"string","format":"email","description":"Primary contact email address of the event host"},"description":{"type":"string","description":"Brief description of the nature of the events put on by the host"},"phone":{"type":"string","format":"phone","description":"Primary contact number of the event host"},"website":{"type":"string","format":"uri","description":"URL of the event host's website, if one exists"},"country":{"type":"string","description":"The country in which the host's events will be primarily staged"},"firstAddressLine":{"type":"string","description":"The first line of the event host's mailing address"},"secondAddressLine":{"type":"string","description":"The second line of the event host's mailing address"},"city":{"type":"string","description":"The city portion of the event host's mailing address"},"district":{"type":"string","description":"The state, parish or district portion of the event host's mailing address"},"businessNo":{"type":"string","description":"The event host's unique registration number, if it maintains a registered business entity"},"events":{"type":"string","description":"URI of the collection of events being staged by this host"}}}},"components/schemas/list-3":{"id":"components/schemas/list-3","kind":"json-schema","title":"list-3","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-5"}}}}},"components/schemas/lookup":{"id":"components/schemas/lookup","kind":"json-schema","title":"lookup","data":{"type":"object","required":["identification"],"properties":{"identification":{"type":"string","description":"The username or email address of the account being looked up"},"role":{"type":"string","description":"The role that an account must be assigned for a successful lookup.\nIf left blank, the lookup will match an account regardles of its role.\n"}}}},"components/schemas/result":{"id":"components/schemas/result","kind":"json-schema","title":"result","data":{"type":"object","properties":{"identification":{"type":"string","description":"The username or email address provided for the account lookup"},"role":{"type":"string","description":"The role provided for the account lookup."},"name":{"type":"string","description":"The name linked to the provided identification ,if one was found."},"found":{"type":"boolean","description":"Whether or not an account matching the provided identification and role was found."}}}},"components/schemas/verification_request":{"id":"components/schemas/verification_request","kind":"json-schema","title":"verification_request","data":{"type":"object","properties":{"email":{"type":"string","description":"Email address to which a verification request code will be sent."}}}},"components/schemas/verification_response":{"id":"components/schemas/verification_response","kind":"json-schema","title":"verification_response","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the verification request resource"},"email":{"type":"string","description":"Email addresss to which the account verification code was sent."},"status":{"type":"string","enum":["Pending","Completed","Expired"],"description":"Current status of the account verification request."}}}},"components/schemas/account_verification":{"id":"components/schemas/account_verification","kind":"json-schema","title":"account_verification","data":{"type":"object","required":["code"],"properties":{"code":{"type":"number","description":"The verification code sent to the account email address."}}}},"components/schemas/reset_request":{"id":"components/schemas/reset_request","kind":"json-schema","title":"reset_request","data":{"type":"object","properties":{"email":{"type":"string","description":"Email address to which a password reset code will be sent."}}}},"components/schemas/reset_response":{"id":"components/schemas/reset_response","kind":"json-schema","title":"reset_response","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the reset request resource"},"email":{"type":"string","description":"Email addresss to which the password reset code was sent."},"status":{"type":"string","enum":["Pending","Completed","Expired"],"description":"Current status of the password reset request."}}}},"components/schemas/password_reset":{"id":"components/schemas/password_reset","kind":"json-schema","title":"password_reset","data":{"type":"object","required":["password","code"],"properties":{"password":{"type":"string","description":"The value the password should be reset to."},"code":{"type":"number","description":"The reset code sent to the account email address."}}}},"components/schemas/toggle":{"id":"components/schemas/toggle","kind":"json-schema","title":"toggle","data":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Reason for activating/deactivating the account."}}}},"components/schemas/deletion":{"id":"components/schemas/deletion","kind":"json-schema","title":"deletion","data":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Reason for requesting account deletion."}}}},"components/schemas/digest":{"id":"components/schemas/digest","kind":"json-schema","title":"digest","data":{"type":"object","properties":{"open":{"type":"boolean","description":"True if the session is currently active, false otherwise"},"ip":{"type":"string","description":"IP Address from which the session was opened"},"agent":{"type":"string","description":"User Agent (UA) string of the agent from which the session was opened"},"started":{"type":"string","format":"date-time","description":"Time at which the session was opened"},"ended":{"type":"string","format":"date-time","description":"Time at which the session was ended, if it is no longer open"}}}},"components/schemas/list-4":{"id":"components/schemas/list-4","kind":"json-schema","title":"list-4","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/digest"}}}}},"components/schemas/response-6":{"id":"components/schemas/response-6","kind":"json-schema","title":"response-6","data":{"type":"object","description":"A geographical region in which events can be staged","properties":{"self":{"type":"string","description":"URI of the region resource"},"name":{"type":"string","description":"Unique name of the region"},"country":{"type":"string","description":"Country in which the region is located"},"district":{"type":"string","description":"Parish, state, province, county, etc. in which the region is located"},"city":{"type":"string","description":"City, town or village in which the region is located"},"icon":{"type":"string","format":"uri","description":"URI of an icon that represents the region (e.g. flag)"}}}},"components/schemas/response-7":{"id":"components/schemas/response-7","kind":"json-schema","title":"response-7","data":{"type":"object","description":"The location at which the event is taking place","properties":{"self":{"type":"string","description":"URI of the venue resource"},"name":{"type":"string","description":"Name of the event venue"},"region":{"description":"URI of the region resource related to this venue","$ref":"#/components/schemas/response-6"},"latitude":{"type":"number","format":"float","description":"Global latitude of the event venue's location"},"longitude":{"type":"number","format":"float","description":"Global longitude of the event venue's location"},"address":{"type":"string","description":"Text representation of the event venue's address"},"map":{"type":"string","format":"uri","description":"URI to a static Google Maps image of the event venue's location"}}}},"components/schemas/response-8":{"id":"components/schemas/response-8","kind":"json-schema","title":"response-8","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the event category resource"},"name":{"type":"string","description":"Unique name of the event category"},"subcategories":{"type":"array","description":"List of subcategories associated with this category","items":{"type":"object","properties":{"self":{"type":"string","description":"URI of the event subcategory resource"},"name":{"type":"string","description":"Unique name of the event subcategory"}}}}}}},"components/schemas/response-9":{"id":"components/schemas/response-9","kind":"json-schema","title":"response-9","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the event resource"},"title":{"type":"string","description":"Unique name of the event"},"description":{"type":"string","description":"Long form text detailing what the event is about, including performing acts,\namenities and additional information important to potential attendees\n"},"start":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to begin"},"end":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to finish"},"host":{"$ref":"#/components/schemas/response-5"},"venue":{"$ref":"#/components/schemas/response-7"},"category":{"$ref":"#/components/schemas/response-8"},"subcategory":{"$ref":"#/components/schemas/response-8"},"disclaimer":{"type":"string","description":"Subcategory under which the event is classified"},"tags":{"type":"array","items":{"type":"string"},"description":"List of short phrases that can be used to search and share the event"},"published":{"type":"string","format":"date-time","description":"The date and time at which the event was first published"},"banner":{"type":"string","format":"uri","description":"URI of the event's banner image"},"thumbnail":{"type":"string","format":"uri","description":"URI of the event's thumbnail image"}}}},"components/schemas/list-5":{"id":"components/schemas/list-5","kind":"json-schema","title":"list-5","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-9"}}}}},"components/schemas/wallet":{"id":"components/schemas/wallet","kind":"json-schema","title":"wallet","data":{"type":"object","properties":{"entries":{"type":"array","description":"List of tickets matching the given criteria","items":{"type":"object","properties":{"serial":{"type":"string","description":"Serial number that uniquely identifies the ticket"},"status":{"type":"string","description":"The ticket's current status"},"section":{"type":"object","description":"The event section to which this ticket grants access","properties":{"self":{"type":"string","format":"uri","description":"URI of the event section resource"},"name":{"type":"string","description":"Name of the event section"},"description":{"type":"string","description":"Details of the experience customers can expect when purchasing tickets to this event section"}}},"issued":{"type":"string","format":"date-time","description":"The date and time at which the ticket was issued"},"redeemed":{"type":"string","format":"date-time","description":"The date and time at which the ticket was redeemed (or N/A if it has not been)"}}}}}}},"components/schemas/account":{"id":"components/schemas/account","kind":"json-schema","title":"account","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the account resource"},"number":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{8}$","description":"Immutable identifier attached to the account"},"username":{"type":"string","description":"Unique username attached to the account"},"email":{"type":"string","format":"email","description":"Unique email address attached to the account"},"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"}}}},"components/schemas/response-10":{"id":"components/schemas/response-10","kind":"json-schema","title":"response-10","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the transfer resource"},"status":{"type":"string","description":"Current status of the transfer"},"initiated":{"type":"string","format":"date-time","description":"The date and time at which the transfer was initiated"},"sender":{"$ref":"#/components/schemas/account"},"recipient":{"$ref":"#/components/schemas/account"},"tickets":{"type":"array","description":"List of tickets involved in the transfer\n","items":{"type":"object","properties":{"event":{"description":"The event section of the ticket being transferred","type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the event resource"},"title":{"type":"string","description":"Unique name of the event"},"description":{"type":"string","description":"Long form text detailing what the event is about, including performing acts,\namenities and additional information important to potential attendees\n"},"status":{"type":"string","description":"Current status of the event"},"start":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to begin"},"end":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to finish"},"banner":{"type":"string","format":"uri","description":"URI of the event's banner image"},"thumbnail":{"type":"string","format":"uri","description":"URI of the event's thumbnail image"}}},"section":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the event section resource"},"name":{"type":"string","description":"Name of the event section"},"description":{"type":"string","description":"Details of the unique experience customers can expect when purchasing tickets to this event section"}}},"quantity":{"type":"integer","description":"Number of tickets for the section being transferred"}}}}}}},"components/schemas/list-6":{"id":"components/schemas/list-6","kind":"json-schema","title":"list-6","data":{"type":"object","properties":{"entries":{"type":"array","description":"List of transfers matching the given criteria","items":{"$ref":"#/components/schemas/response-10"}}}}},"components/schemas/request-3":{"id":"components/schemas/request-3","kind":"json-schema","title":"request-3","data":{"type":"object","required":["name","contact","email"],"properties":{"name":{"type":"string","description":"Unique name of the event host"},"contact":{"type":"string","description":"First and last name of the event host's primary contact person"},"email":{"type":"string","format":"email","description":"Primary contact email address of the event host"},"description":{"type":"string","description":"Brief description of the nature of the events put on by the host"},"phone":{"type":"string","format":"phone","description":"Primary contact number of the event host"},"website":{"type":"string","format":"uri","description":"URL of the event host's website, if one exists"},"country":{"type":"string","description":"The country in which the host's events will be primarily staged"},"firstAddressLine":{"type":"string","description":"The first line of the event host's mailing address"},"secondAddressLine":{"type":"string","description":"The second line of the event host's mailing address"},"city":{"type":"string","description":"The city portion of the event host's mailing address"},"state":{"type":"string","description":"The state, parish or district portion of the event host's mailing address"},"businessNo":{"type":"string","description":"The event host's unique registration number, if it maintains a registered business entity"}}}},"components/schemas/request-4":{"id":"components/schemas/request-4","kind":"json-schema","title":"request-4","data":{"type":"object","required":["user","role"],"properties":{"user":{"type":"string","format":"email","description":"The email address of the user to whom the privilege is to be granted."},"role":{"type":"string","enum":["Administrator","Editor","Viewer"],"description":"Role that the privilege should confer upon the user."}}}},"components/schemas/role":{"id":"components/schemas/role","kind":"json-schema","title":"role","data":{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["Administrator","Editor","Viewer"],"description":"Role that the privilege should confer upon the user."}}}},"components/schemas/response-11":{"id":"components/schemas/response-11","kind":"json-schema","title":"response-11","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the event resource"},"title":{"type":"string","description":"Unique name of the event"},"description":{"type":"string","description":"Long form text detailing what the event is about, including performing acts,\namenities and additional information important to potential attendees\n"},"type":{"type":"string","description":"Nature of the event. Determines what information is collected on ticket purchase."},"public":{"type":"boolean","description":"Whether or not the event is open to the general public"},"start":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to begin"},"end":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to finish"},"status":{"type":"string","enum":["Draft","Pending","Approved","Rejected","Scheduled","Published"],"description":"Publication status of the event"},"venue":{"$ref":"#/components/schemas/response-7"},"category":{"$ref":"#/components/schemas/response-8"},"subcategory":{"$ref":"#/components/schemas/response-8"},"disclaimer":{"type":"string","description":"Subcategory under which the event is classified"},"tags":{"type":"array","items":{"type":"string"},"description":"List of short phrases that can be used to search and share the event"},"published":{"type":"string","format":"date-time","description":"The date and time at which the event was first published"},"popularity":{"type":"number","description":"The popularity score of the event. Higher scores indicate greater popularity."},"banner":{"type":"string","format":"uri","description":"URI of the event's banner image"},"thumbnail":{"type":"string","format":"uri","description":"URI of the event's thumbnail image"}}}},"components/schemas/list-7":{"id":"components/schemas/list-7","kind":"json-schema","title":"list-7","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-11"}}}}},"components/schemas/request-5":{"id":"components/schemas/request-5","kind":"json-schema","title":"request-5","data":{"type":"object","required":["type","title","description","category","subcategory","venue","public"],"properties":{"title":{"type":"string","description":"Unique name of the event"},"description":{"type":"string","description":"Long form text detailing what the event is about, including performing acts,\namenities and additional information important to potential attendees\n"},"type":{"type":"string","enum":["Standard","Registration"],"description":"Nature of the event. Determines what information is collected on ticket purchase."},"public":{"type":"boolean","description":"Whether or not the event is open to the general public"},"category":{"type":"string","description":"URI of the category under which the event is classified"},"subcategory":{"type":"string","description":"Subcategory under which the event is classified"},"start":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to begin"},"end":{"type":"string","format":"date-time","description":"The date and time at which the event is scheduled to finish"},"venue":{"type":"string","description":"URI of the venue at which the event is taking place"},"disclaimer":{"type":"string","description":"Subcategory under which the event is classified"},"tags":{"type":"array","items":{"type":"string"},"description":"List of short phrases that can be used to search and share the event"},"banner":{"type":"string","format":"base64","description":"Base64 representation of the event's banner image data"},"thumbnail":{"type":"string","format":"base64","description":"Base64 representation of the event's thumbnail image data"}}}},"components/schemas/response-12":{"id":"components/schemas/response-12","kind":"json-schema","title":"response-12","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the submission resource"},"type":{"description":"Resource class for which changes have been submitted.","type":"string","enum":["event","host"]},"resource":{"description":"Unique identifier of the resource for which changes have been submitted.","type":"string","pattern":"^[0-9]{14}$"},"previous":{"description":"The original resource content that is being changed.","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"changes":{"description":"The changes to the resource being submitted for review.","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"note":{"description":"Note included wuth the submission for attention of the reviewer","type":"string"},"status":{"description":"Current status of the submission.","type":"string","enum":["Pending","Approved","Rejected"]}}}},"components/schemas/list-8":{"id":"components/schemas/list-8","kind":"json-schema","title":"list-8","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-12"}}}}},"components/schemas/request-6":{"id":"components/schemas/request-6","kind":"json-schema","title":"request-6","data":{"type":"object","required":["note"],"properties":{"note":{"description":"Note included wuth the submission for attention of the reviewer","type":"string"}}}},"components/schemas/response-13":{"id":"components/schemas/response-13","kind":"json-schema","title":"response-13","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the publication resource"},"changes":{"description":"The changes that were published.","type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]}},"publish_at":{"description":"Date at which the changes were (or will be) published.","type":"string","format":"date-time"}}}},"components/schemas/list-9":{"id":"components/schemas/list-9","kind":"json-schema","title":"list-9","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-13"}}}}},"components/schemas/request-7":{"id":"components/schemas/request-7","kind":"json-schema","title":"request-7","data":{"type":"object","required":["publish_at"],"properties":{"publish_at":{"type":"string","format":"date-time","description":"Date and time at which changes should be published. Changes will be published immediately if the datetime is in the past."}}}},"components/schemas/response-14":{"id":"components/schemas/response-14","kind":"json-schema","title":"response-14","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the event resource"},"name":{"type":"string","description":"Name of the tier"},"description":{"type":"string","description":"Informative or promotional text containing details of the tier."},"price":{"type":"number","description":"Cost of purchasing tickets in this tier."},"capacity":{"type":"integer","description":"Total number of tickets available for purchase in this tier."},"available_from":{"type":"string","format":"date-time","description":"The date and time after which tickets in this tier can be purchased."},"available_to":{"type":"string","format":"date-time","description":"The date and time until which tickets in this tier can be purchased."},"events":{"type":"array","minLength":1,"description":"The group of events this tier applies to. When this tier is purchased tickets are\nissued to each event listed.\n","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identfier of an event included in this tier"},"share":{"type":"number","description":"Proportion of the tier price attributable to this item. The shares of all\nbundle items must total 100.\n"}}}},"artwork":{"type":"string","format":"uri","description":"URI of the tier's associated artwork or image"},"unit_size":{"type":"integer","description":"The number of tickets that will be issued to the user upon purchase of this tier."},"purchase_limit":{"type":"integer","description":"The maximum number of tickets that can be purchased from this tier in a single order"},"purchase_note":{"type":"string","description":"A note sent to customers upon issuance of tickets wihin this tier, providing addiional\nevent details, disclaimers or privileged content.\n"},"complimentary":{"type":"boolean","description":"Whether or not tickets issued under this tier are for complimentary distrbution by the host (true) or available\nfor purchase (false)\n"},"transferable":{"type":"boolean","description":"Whether or not tickets issued under this tier can be transferred after issuance (true) or must be user by the\ncustomer they were issued to (false)\n"},"upgrades":{"type":"array","description":"List of 'promotion tiers' to which tickets issued under this tier can be upgraded.","items":{"$ref":"#/components/schemas/response-14"}},"gross_sales":{"type":"number","description":"Total gross from confirmed sales of tickets within this tier"},"units_sold":{"type":"number","description":"Total number of units of this tier sold"}}}},"components/schemas/list-10":{"id":"components/schemas/list-10","kind":"json-schema","title":"list-10","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-14"}}}}},"components/schemas/request-8":{"id":"components/schemas/request-8","kind":"json-schema","title":"request-8","data":{"type":"object","required":["name","description","price","capacity","available_from","available_to","events"],"properties":{"name":{"type":"string","description":"Name of the tier"},"description":{"type":"string","description":"Informative or promotional text containing details of the tier."},"price":{"type":"number","minimum":0,"description":"Cost of purchasing tickets in this tier."},"capacity":{"type":"integer","minimum":1,"description":"Total number of tickets available for purchase in this tier."},"available_from":{"type":"string","format":"date-time","description":"The date and time after which tickets in this tier can be purchased."},"available_to":{"type":"string","format":"date-time","description":"The date and time until which tickets in this tier can be purchased."},"events":{"type":"array","minLength":1,"description":"The group of events this tier applies to. When this tier is purchased tickets are\nissued to each event listed.\n","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identfier of an event included in this tier"},"share":{"type":"number","description":"Proportion of the tier price attributable to this item. The shares of all\nbundle items must total 100.\n"}}}},"artwork":{"type":"string","format":"base64","description":"Base64 representation of artwork or an image associated with the tier."},"unit_size":{"type":"integer","minimum":1,"default":1,"description":"The number of tickets that will be issued to the user upon purchase of this tier."},"purchase_limit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of tickets that can be purchased from this tier in a single order"},"purchase_note":{"type":"string","description":"A note sent to customers upon issuance of tickets wihin this tier, providing addiional\nevent details, disclaimers or privileged content.\n"},"complimentary":{"type":"boolean","default":false,"description":"Whether or not tickets issued under this tier are for complimentary distrbution by the host (true) or available\nfor purchase (false)\n"},"transferable":{"type":"boolean","default":true,"description":"Whether or not tickets issued under this tier can be transferred after issuance (true) or must be user by the\ncustomer they were issued to (false)\n"},"upgrades":{"type":"array","description":"List of unique tier identifiers indicating 'promotion tiers' to which tickets issued under this tier can be upgraded.","items":{"type":"integer"}}}}},"components/schemas/response-15":{"id":"components/schemas/response-15","kind":"json-schema","title":"response-15","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the tier resource"},"name":{"type":"string","description":"Name of the tier"},"description":{"type":"string","description":"Informative or promotional text containing details of the tier."},"price":{"type":"number","description":"Cost of purchasing tickets in this tier."},"available_from":{"type":"string","format":"date-time","description":"The date and time after which tickets in this tier can be purchased."},"available_to":{"type":"string","format":"date-time","description":"The date and time until which tickets in this tier can be purchased."},"events":{"type":"array","minLength":1,"description":"The group of events this tier applies to. When this tier is purchased tickets are\nissued to each event listed.\n","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identfier of an event included in this tier"},"share":{"type":"number","description":"Proportion of the tier price attributable to this item. The shares of all\nbundle items must total 100.\n"}}}},"artwork":{"type":"string","format":"uri","description":"URI of the tier's associated artwork or image"},"unit_size":{"type":"integer","description":"The number of tickets that will be issued to the user upon purchase of this tier."},"purchase_limit":{"type":"integer","description":"The maximum number of tickets that can be purchased from this tier in a single order"},"upgrades":{"type":"array","description":"List of 'promotion tiers' to which tickets issued under this tier can be upgraded.","items":{"$ref":"#/components/schemas/response-15"}}}}},"components/schemas/list-11":{"id":"components/schemas/list-11","kind":"json-schema","title":"list-11","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-15"}}}}},"components/schemas/response-16":{"id":"components/schemas/response-16","kind":"json-schema","title":"response-16","data":{"type":"object","properties":{"self":{"type":"string","description":"URI of the sale resource"},"recorded":{"type":"string","format":"date-time","description":"The date and time at which the sale was recorded"},"order":{"type":"string","description":"Unique identifier of the order that generated the sale"},"event":{"$ref":"#/components/schemas/response-9"},"tier":{"$ref":"#/components/schemas/response-15"},"customer":{"$ref":"#/components/schemas/response-3"},"quantity":{"type":"number","description":"The number of tickets the sale is for"},"total":{"type":"number","description":"Monetary value of the sale"},"status":{"type":"string","enum":["pending","cancelled","confirmed","refunded"],"description":"Current status of the recorded sale"},"payment":{"type":"object","description":"Details of the payment instrument used to confirm the sale, if applicable","properties":{"method":{"type":"string","enum":["cash","card"],"description":"Type of payment instrument used to confirm the sale"},"cardholder":{"type":"string","description":"Name of the holder of the payment instrument if it was a debit or credit card"},"digits":{"type":"string","description":"Last 4 digits of the payment instrument if it was a debit or credit card"},"type":{"type":"string","enum":["visa","mc","amex"],"description":"Network of the payment instrument if it was a debit or credit card"}}}}}},"components/schemas/list-12":{"id":"components/schemas/list-12","kind":"json-schema","title":"list-12","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-16"}}}}},"components/schemas/response-17":{"id":"components/schemas/response-17","kind":"json-schema","title":"response-17","data":{"type":"object","properties":{"start":{"type":"string","description":"The date after which activity must have taken place to be included in the statistics"},"end":{"type":"string","description":"The date before which activity must have taken place to be included in the statistics"},"gross_sales":{"type":"number","description":"Total gross sales over the specified period"},"tickets_sold":{"type":"number","description":"Total tickets sold over the specified period"},"breakdown":{"type":"array","items":{"type":"object","properties":{"interval":{"type":"string","description":"Name of the subperiod for which the aggregated statistics apply"},"gross_sales":{"type":"number","description":"Total gross sales over the interval"},"tickets_sold":{"type":"number","description":"Total tickets sold over the interval"}}}}}}},"components/schemas/response-18":{"id":"components/schemas/response-18","kind":"json-schema","title":"response-18","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the token resource"},"code":{"type":"string","description":"The code used to uniquely identify this token in the system"},"global":{"type":"boolean","description":"Whether or not this is a global event token"},"sections":{"type":"array","description":"List of sections this token can redeem tickets for.","items":{"type":"string","format":"uri","description":"URI of the event section resource"}}}}},"components/schemas/list-13":{"id":"components/schemas/list-13","kind":"json-schema","title":"list-13","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-18"}}}}},"components/schemas/request-9":{"id":"components/schemas/request-9","kind":"json-schema","title":"request-9","data":{"type":"object","required":["sections"],"properties":{"sections":{"type":"array","description":"List of sections this token can redeem tickets for.","items":{"type":"string","format":"uri","description":"URI of the event section resource"}}}}},"components/schemas/response-19":{"id":"components/schemas/response-19","kind":"json-schema","title":"response-19","data":{"type":"object","properties":{"serial":{"type":"string","description":"Serial number that uniquely identifies the ticket"},"status":{"type":"string","description":"The ticket's current status"},"section":{"type":"object","description":"The event section to which this ticket grants access","properties":{"self":{"type":"string","format":"uri","description":"URI of the event section resource"},"name":{"type":"string","description":"Name of the event section"},"description":{"type":"string","description":"Details of the experience customers can expect when purchasing tickets to this event section"}}},"owner":{"type":"object","description":"Details of the user account that holds the ticket","properties":{"self":{"type":"string","format":"uri","description":"URI of the account resource"},"number":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{8}$","description":"Immutable identifier attached to the account"},"username":{"type":"string","description":"Unique username attached to the account"},"email":{"type":"string","format":"email","description":"Unique email address attached to the account"},"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"}}},"issued":{"type":"string","format":"date-time","description":"The date and time at which the ticket was issued"},"redeemed":{"type":"string","format":"date-time","description":"The date and time at which the ticket was redeemed (or N/A if it has not been)"}}}},"components/schemas/list-14":{"id":"components/schemas/list-14","kind":"json-schema","title":"list-14","data":{"type":"object","properties":{"entries":{"type":"array","description":"List of tickets matching the given criteria","items":{"$ref":"#/components/schemas/response-19"}}}}},"components/schemas/response-20":{"id":"components/schemas/response-20","kind":"json-schema","title":"response-20","data":{"type":"object","properties":{"redeemer":{"type":"string","description":"Human-readable name of the person who redeemed the ticket"},"device":{"type":"string","description":"Unique identifier of the device from which the ticket was redeemed"},"ticket":{"type":"string","description":"Serial number of the ticket that granted admission"},"patron":{"type":"object","description":"Full name and username of the TickeTing user admitted on this ticket","properties":{"username":{"type":"string","description":"Unique username attached to the account"},"email":{"type":"string","format":"email","description":"Unique email address attached to the account"},"firstName":{"type":"string","description":"The account holder's forename"},"lastName":{"type":"string","description":"The account holder's surname"}}},"section":{"type":"object","description":"Name of the event section the patron was admitted to","properties":{"self":{"type":"string","format":"uri","description":"URI of the event section resource"},"name":{"type":"string","description":"Name of the event section"},"description":{"type":"string","description":"Details of the experience customers can expect when purchasing tickets to this event section"}}},"admitted":{"type":"string","format":"date-time","description":"The date and time at which the patron was admitted"}}}},"components/schemas/list-15":{"id":"components/schemas/list-15","kind":"json-schema","title":"list-15","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-20"}}}}},"components/schemas/request-10":{"id":"components/schemas/request-10","kind":"json-schema","title":"request-10","data":{"type":"object","required":["redeemer","device","serials"],"properties":{"redeemer":{"type":"string","description":"Human-readable name of the person redeeming the listed tickets"},"device":{"type":"string","description":"Unique identifier of the device the tickets are being redeemed from"},"serials":{"type":"array","description":"List of ticket serials to redeem for admission to this event","items":{"type":"string"}}}}},"components/schemas/collection":{"id":"components/schemas/collection","kind":"json-schema","title":"collection","data":{"type":"array","description":"List of admissions granted by the provided serial numbers","items":{"$ref":"#/components/schemas/response-20"}}},"components/schemas/response-21":{"id":"components/schemas/response-21","kind":"json-schema","title":"response-21","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the order resource"},"number":{"type":"string","description":"Unique identifier of the order"},"status":{"type":"string","description":"Current status of the order"},"placed":{"type":"string","format":"date-time","description":"The date and time at which the order was placed"},"subtotal":{"type":"number","format":"float","description":"Total cost of the ordered items, before convenience fees are applied"},"fees":{"type":"number","format":"float","description":"Total applicable convenience fees for this order"},"total":{"type":"number","format":"float","description":"Total to be paid for this order inclusive of item costs (subtotal) and fees"},"items":{"type":"array","description":"List of items that were ordered\n","items":{"type":"object","properties":{"tier":{"type":"object","description":"Details of the ordered tier","properties":{"self":{"type":"string","description":"URI of the tier resource"},"name":{"type":"string","description":"Name of the tier"},"description":{"type":"string","description":"Informative or promotional text containing details of the tier."},"price":{"type":"number","description":"Cost of purchasing tickets in this tier."},"available_from":{"type":"string","format":"date-time","description":"The date and time after which tickets in this tier can be purchased."},"available_to":{"type":"string","format":"date-time","description":"The date and time until which tickets in this tier can be purchased."},"events":{"type":"array","minLength":1,"description":"The group of events this tier applies to. When this tier is purchased tickets are\nissued to each event listed.\n","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identfier of an event included in this tier"},"share":{"type":"number","description":"Proportion of the tier price attributable to this item. The shares of all\nbundle items must total 100.\n"}}}},"artwork":{"type":"string","format":"uri","description":"URI of the tier's associated artwork or image"},"unit_size":{"type":"integer","description":"The number of tickets that will be issued to the user upon purchase of this tier."},"purchase_limit":{"type":"integer","description":"The maximum number of tickets that can be purchased from this tier in a single order"},"upgrades":{"type":"array","description":"List of 'promotion tiers' to which tickets issued under this tier can be upgraded.","items":{"$ref":"#/components/schemas/response-15"}}}},"quantity":{"type":"number","description":"Number of instances of this item that were ordered"}}}},"payment":{"type":"object","description":"Details of the payment for this order.","properties":{"uri":{"type":"string","format":"uri","description":"URI used for completing order payment."},"status":{"type":"string","enum":["Pending","Completed","Failed","Cancelled"],"description":"Current order payment status"},"method":{"type":"object","description":"Details of the method used to complete payment","properties":{"cardholder":{"type":"string","description":"Name of the payment card holder as printed on the card"},"card_type":{"type":"string","description":"The type of card used to complete payment (Visa, Mastercard, etc.)"},"card_digits":{"type":"string","description":"Last 4 digits of the card used to complete payment"}}}}}}}},"components/schemas/list-16":{"id":"components/schemas/list-16","kind":"json-schema","title":"list-16","data":{"type":"object","properties":{"entries":{"type":"array","description":"List of orders matching the given criteria","items":{"$ref":"#/components/schemas/response-21"}}}}},"components/schemas/request-11":{"id":"components/schemas/request-11","kind":"json-schema","title":"request-11","data":{"type":"object","required":["items"],"properties":{"items":{"description":"Sections for which to order tickets. The object's keys are the URI of the event section for which tickets are being ordered, while its values are the number of tickets to order for the section.","type":"array","items":{"type":"object","properties":{"tier":{"type":"integer","description":"Unique identfier of the tier to be included in the order"},"quantity":{"type":"number","description":"The number of instances in the identified tier to include in the order"}}}}}}},"components/schemas/request-12":{"id":"components/schemas/request-12","kind":"json-schema","title":"request-12","data":{"type":"object","required":["number","cvv","expiryDate","name","email","phone","address1","city","district","country"],"properties":{"number":{"type":"string","pattern":"^\\d{16}$","description":"16-Digit Primary Account Number (PAN) of the payment"},"cvv":{"type":"number","format":"integer","description":"3-Digit Card Verification Value (CVV) of the payment card"},"expiryDate":{"type":"string","pattern":"^\\d{2}/\\d{2}$","description":"Expiry date of the payment card in the format MM/YY"},"name":{"type":"string","description":"Name of the payment card holder as printed on the front of the card"},"email":{"type":"string","format":"email","description":"Email address of the payment card holder"},"phone":{"type":"string","format":"phone","description":"Phone number of the payment card holder"},"address1":{"type":"string","description":"First line of the payment card holder's billing address"},"address2":{"type":"string","description":"Second line of the payment card holder's billing address"},"city":{"type":"string","description":"City of the payment card holder's billing address"},"district":{"type":"string","description":"Parish/State/Province of the payment card holder's billing address"},"country":{"type":"string","description":"Country of the payment card holder's billing address"}}}},"components/schemas/response-22":{"id":"components/schemas/response-22","kind":"json-schema","title":"response-22","data":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"The date/time at which the payment was attempted"},"amount":{"type":"number","format":"float","description":"The attempted payment amount"},"status":{"type":"string","enum":["Authorised","Declined"],"description":"The end result of the payment attempt"}}}},"components/schemas/request-13":{"id":"components/schemas/request-13","kind":"json-schema","title":"request-13","data":{"type":"object","properties":{"sender":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{8}$","description":"Unique identifier of the account initiating this transfer"},"recipient":{"type":"string","description":"Username or email address of the intended recipient"},"tickets":{"type":"object","description":"Sections for which to transfer tickets. The object's keys are the URI of the event section of the tickets being transferred, while its values are the number of tickets to transfer for that section.","additionalProperties":{"description":"Number of tickets to transfer for the specified section","type":"number","format":"integer"}}}}},"components/schemas/response-23":{"id":"components/schemas/response-23","kind":"json-schema","title":"response-23","data":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"The date/time at which the transfer was claimed"},"claimant":{"type":"string","description":"Full name and username of the TickeTing user that claimed the transfer"},"success":{"type":"boolean","description":"True if the transfer was successfully claimed, false otherwise"}}}},"components/schemas/list-17":{"id":"components/schemas/list-17","kind":"json-schema","title":"list-17","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-6"}}}}},"components/schemas/request-14":{"id":"components/schemas/request-14","kind":"json-schema","title":"request-14","data":{"type":"object","required":["name","country"],"properties":{"name":{"type":"string","description":"Unique name of the region"},"country":{"type":"string","description":"Country in which the region is located"},"district":{"type":"string","description":"Parish, state, province, county, etc. in which the region is located"},"city":{"type":"string","description":"City, town or village in which the region is located"}}}},"components/schemas/list-18":{"id":"components/schemas/list-18","kind":"json-schema","title":"list-18","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-7"}}}}},"components/schemas/request-15":{"id":"components/schemas/request-15","kind":"json-schema","title":"request-15","data":{"type":"object","required":["name","region","latitude","longitude","address"],"properties":{"name":{"type":"string","description":"Name of the event venue"},"region":{"type":"string","pattern":"^\\d{14}$","description":"Unique identifier of the region in which this venue is located"},"latitude":{"type":"number","format":"float","description":"Global latitude of the event venue's location"},"longitude":{"type":"number","format":"float","description":"Global longitude of the event venue's location"},"address":{"type":"string","description":"Text representation of the event venue's address"}}}},"components/schemas/list-19":{"id":"components/schemas/list-19","kind":"json-schema","title":"list-19","data":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/response-8"}}}}},"components/schemas/request-16":{"id":"components/schemas/request-16","kind":"json-schema","title":"request-16","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Unique name of the event category"},"subcategories":{"type":"array","description":"List of subtypes associated with this category","items":{"type":"string"}}}}},"components/schemas/response-24":{"id":"components/schemas/response-24","kind":"json-schema","title":"response-24","data":{"type":"object","properties":{"approved":{"type":"boolean","description":"True if the submitted content was approved for publication, false if it was rejected."},"note":{"description":"Note included wuth the decision for attention of the submitter.","type":"string"}}}},"components/schemas/request-17":{"id":"components/schemas/request-17","kind":"json-schema","title":"request-17","data":{"type":"object","required":["approved"],"properties":{"approved":{"type":"boolean","description":"Whether or not to approve (true) or reject (false) the submitted content."},"note":{"description":"Note included wuth the decision for attention of the submitter.","type":"string"}}}},"components/schemas/countries":{"id":"components/schemas/countries","kind":"json-schema","title":"countries","data":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"URI of the country list resource"},"countries":{"type":"array","description":"List of country names","items":{"type":"string"}}}}},"schema_41":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"integer","default":25},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list"}]},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-2"}]},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-3"}]},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"number"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-4"}]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"string","enum":["alphabetical","published","popularity","start"]},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"asc"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-5"}]},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{14}$"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["Issued","Pending","Held","Redeemed","Expired"]}},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/wallet"}]},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"string","enum":["sender","recipient"]},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","enum":["Pending","Claimed","Cancelled"]},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-6"}]},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"string","enum":["alphabetical"]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-7"}]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-8"}]},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-9"}]},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-10"}]},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-11"}]},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","enum":["pending","cancelled","confirmed","refunded"]},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"string","enum":["recorded","total"]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-12"}]},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","enum":["hour","day","week","month","year"]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-13"}]},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-14"}]},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"string","pattern":"^\\w{6}-\\w{4}\\d{8}$"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"string","pattern":"^[A-Z]{2}-[A-Z0-9]{8}$"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-15"}]},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"string","enum":["Placed","Cancelled","Timed Out","Fulfilled","Voided","Returned"]},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"string","enum":["date"]},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-16"}]},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-17"}]},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-18"}]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/results"},{"$ref":"#/components/schemas/list-19"}]},"id":"schema_81"}},"exampleStore":{"paths/~1sessions/post/requestBody/content/application~1json/example":{"value":{"identification":"mothers.milk","password":"Dxath2$up3$"},"id":"paths/~1sessions/post/requestBody/content/application~1json/example"},"paths/~1sessions/post/responses/201/content/application~1json/example":{"value":{"self":"/sessions/7c69fb3eeb3c910f049d9d72bec05e0d","id":16881177390522,"open":true,"started":"2023-06-30 10:35:39","key":"7c69fb3eeb3c910f049d9d72bec05e0d","account":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr.","dateOfBirth":"14-09-1974","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's"}},"id":"paths/~1sessions/post/responses/201/content/application~1json/example"},"paths/~1sessions/post/responses/404/content/application~1json/example":{"value":{"message":"The requested account could not be located."},"id":"paths/~1sessions/post/responses/404/content/application~1json/example"},"paths/~1sessions~1active/get/responses/200/content/application~1json/example":{"value":{"self":"/sessions/7c69fb3eeb3c910f049d9d72bec05e0d","id":16881177390522,"open":true,"started":"2023-06-30 10:35:39","key":"7c69fb3eeb3c910f049d9d72bec05e0d","account":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr.","dateOfBirth":"14-09-1974","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's"}},"id":"paths/~1sessions~1active/get/responses/200/content/application~1json/example"},"paths/~1sessions~1active/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from accessing this resource."},"id":"paths/~1sessions~1active/get/responses/403/content/application~1json/example"},"paths/~1sessions~1active/delete/responses/200/content/application~1json/example":{"value":{"message":"The active session was ended successfully."},"id":"paths/~1sessions~1active/delete/responses/200/content/application~1json/example"},"paths/~1sessions~1active/delete/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from accessing this resource."},"id":"paths/~1sessions~1active/delete/responses/403/content/application~1json/example"},"paths/~1tokens~1{code}/get/responses/200/content/application~1json/example":{"value":{"key":"11a6f64c842142235g8668c5ff77024c","event":"/events/16993717817996","sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},"id":"paths/~1tokens~1{code}/get/responses/200/content/application~1json/example"},"paths/~1tokens~1{code}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be located."},"id":"paths/~1tokens~1{code}/get/responses/404/content/application~1json/example"},"paths/~1integrations/post/requestBody/content/application~1json/example":{"value":{"name":"TickeTing Live Events Calendar","access":"public"},"id":"paths/~1integrations/post/requestBody/content/application~1json/example"},"paths/~1integrations/post/responses/201/content/application~1json/example":{"value":{"name":"TickeTing Live Events Calendar","access":"public","key":"dcbb49fdd05a58ea59cb6c024b76fb68"},"id":"paths/~1integrations/post/responses/201/content/application~1json/example"},"paths/~1integrations/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1integrations/post/responses/400/content/application~1json/example"},"paths/~1integrations/post/responses/409/content/application~1json/example":{"value":{"message":"The following arguments conflict with those of another token: name."},"id":"paths/~1integrations/post/responses/409/content/application~1json/example"},"paths/~1accounts/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's","preferences":"/accounts/MO-6A39EE8D/preferences"}]},"id":"paths/~1accounts/get/responses/200/content/application~1json/example"},"paths/~1accounts/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts/get/responses/404/content/application~1json/example"},"paths/~1accounts/post/requestBody/content/application~1json/example":{"value":{"username":"mothers.milk","password":"WuT4NGcl4n","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's"},"id":"paths/~1accounts/post/requestBody/content/application~1json/example"},"paths/~1accounts/post/responses/201/content/application~1json/example":{"value":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's","preferences":"/accounts/MO-6A39EE8D/preferences"},"id":"paths/~1accounts/post/responses/201/content/application~1json/example"},"paths/~1accounts/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1accounts/post/responses/400/content/application~1json/example"},"paths/~1accounts/post/responses/409/content/application~1json/example":{"value":{"message":"The following arguments conflict with those of another user: username."},"id":"paths/~1accounts/post/responses/409/content/application~1json/example"},"paths/~1accounts~1{number}/get/responses/200/content/application~1json/example":{"value":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's","preferences":"/accounts/MO-6A39EE8D/preferences"},"id":"paths/~1accounts~1{number}/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}/get/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access or modify this account."},"id":"paths/~1accounts~1{number}/get/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}/put/requestBody/content/application~1json/example":{"value":{"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"New Safe House","secondAddressLine":"","city":"Undisclosed","state":"Undisclosed"},"id":"paths/~1accounts~1{number}/put/requestBody/content/application~1json/example"},"paths/~1accounts~1{number}/put/responses/200/content/application~1json/example":{"value":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's","preferences":"/accounts/MO-6A39EE8D/preferences"},"id":"paths/~1accounts~1{number}/put/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1accounts~1{number}/put/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}/put/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access or modify this account."},"id":"paths/~1accounts~1{number}/put/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}/delete/responses/200/content/application~1json/example":{"value":{"message":"/account/MO-6A39EE8D, has been deleted."},"id":"paths/~1accounts~1{number}/delete/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}/delete/responses/409/content/application~1json/example":{"value":{"message":"An account cannot be deleted if it holds active tickets."},"id":"paths/~1accounts~1{number}/delete/responses/409/content/application~1json/example"},"paths/~1accounts~1{number}~1preferences/get/responses/200/content/application~1json/example":{"value":{"region":"/regions/19290238432215"},"id":"paths/~1accounts~1{number}~1preferences/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1preferences/get/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access or modify this account."},"id":"paths/~1accounts~1{number}~1preferences/get/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example":{"value":{"region":"/regions/19290238432215"},"id":"paths/~1accounts~1{number}~1preferences/put/requestBody/content/application~1json/example"},"paths/~1accounts~1{number}~1preferences/put/responses/200/content/application~1json/example":{"value":{"region":"/regions/19290238432215"},"id":"paths/~1accounts~1{number}~1preferences/put/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1preferences/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1accounts~1{number}~1preferences/put/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}~1preferences/put/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access or modify this account."},"id":"paths/~1accounts~1{number}~1preferences/put/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1privileges/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/hosts/16951985851389/privileges/18294757620193","user":"billy.butcher@fbsa.gov","role":{"name":"Administrator","permissions":["retrieve_host","modify_host","delete_host","list_host_events","create_event"]},"type":"host","resource":16951985851389,"pending":false}]},"id":"paths/~1accounts~1{number}~1privileges/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1privileges/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1privileges/get/responses/404/content/application~1json/example"},"paths/~1accounts~1{number}~1hosts/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":5,"entries":[{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"}]},"id":"paths/~1accounts~1{number}~1hosts/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1hosts/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1hosts/get/responses/404/content/application~1json/example"},"paths/~1lookups/post/requestBody/content/application~1json/example":{"value":{"identification":"marvin.milk@usmc.gov","role":"host"},"id":"paths/~1lookups/post/requestBody/content/application~1json/example"},"paths/~1lookups/post/responses/200/content/application~1json/example":{"value":{"identification":"mothers.milk","role":"host","name":"Marvin Milk","found":false},"id":"paths/~1lookups/post/responses/200/content/application~1json/example"},"paths/~1lookups/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1lookups/post/responses/400/content/application~1json/example"},"paths/~1verifications/post/requestBody/content/application~1json/example":{"value":{"email":"marvin.milk@usmc.gov"},"id":"paths/~1verifications/post/requestBody/content/application~1json/example"},"paths/~1verifications/post/responses/201/content/application~1json/example":{"value":{"self":"/verifications/16485226592997","email":"marvin.milk@usmc.gov","status":"Pending"},"id":"paths/~1verifications/post/responses/201/content/application~1json/example"},"paths/~1verifications/post/responses/400/content/application~1json/example":{"value":{"message":"You must provide an email address to which to send the verification code."},"id":"paths/~1verifications/post/responses/400/content/application~1json/example"},"paths/~1verifications/post/responses/404/content/application~1json/example":{"value":{"message":"The requested account could not be located"},"id":"paths/~1verifications/post/responses/404/content/application~1json/example"},"paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example":{"value":{"code":914828},"id":"paths/~1verifications~1{verification}/patch/requestBody/content/application~1json/example"},"paths/~1verifications~1{verification}/patch/responses/200/content/application~1json/example":{"value":{"message":"The account has been successfully verified."},"id":"paths/~1verifications~1{verification}/patch/responses/200/content/application~1json/example"},"paths/~1verifications~1{verification}/patch/responses/400/content/application~1json/example":{"value":{"message":"The provided account verification code is incorrect."},"id":"paths/~1verifications~1{verification}/patch/responses/400/content/application~1json/example"},"paths/~1verifications~1{verification}/patch/responses/409/content/application~1json/example":{"value":{"message":"The account verification request has already been completed or expired."},"id":"paths/~1verifications~1{verification}/patch/responses/409/content/application~1json/example"},"paths/~1resets/post/requestBody/content/application~1json/example":{"value":{"email":"marvin.milk@usmc.gov"},"id":"paths/~1resets/post/requestBody/content/application~1json/example"},"paths/~1resets/post/responses/201/content/application~1json/example":{"value":{"self":"/resets/16947291161016","email":"marvin.milk@usmc.gov","status":"Pending"},"id":"paths/~1resets/post/responses/201/content/application~1json/example"},"paths/~1resets/post/responses/400/content/application~1json/example":{"value":{"message":"You must provide an email address to which to send the reset code."},"id":"paths/~1resets/post/responses/400/content/application~1json/example"},"paths/~1resets/post/responses/404/content/application~1json/example":{"value":{"message":"The requested account could not be located"},"id":"paths/~1resets/post/responses/404/content/application~1json/example"},"paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example":{"value":{"password":"Th380Y$4L1F3","code":842164},"id":"paths/~1resets~1{reset}/patch/requestBody/content/application~1json/example"},"paths/~1resets~1{reset}/patch/responses/200/content/application~1json/example":{"value":{"message":"The account password has been reset."},"id":"paths/~1resets~1{reset}/patch/responses/200/content/application~1json/example"},"paths/~1resets~1{reset}/patch/responses/400/content/application~1json/example":{"value":{"message":"The provided password reset code is incorrect."},"id":"paths/~1resets~1{reset}/patch/responses/400/content/application~1json/example"},"paths/~1resets~1{reset}/patch/responses/409/content/application~1json/example":{"value":{"message":"The password reset request has already been completed or expired."},"id":"paths/~1resets~1{reset}/patch/responses/409/content/application~1json/example"},"paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example":{"value":{"reason":"Account suspected of fraud."},"id":"paths/~1accounts~1{number}~1toggles/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{number}~1toggles/post/responses/201/content/application~1json/example":{"value":{"message":"The account was deactivated successfully."},"id":"paths/~1accounts~1{number}~1toggles/post/responses/201/content/application~1json/example"},"paths/~1accounts~1{number}~1toggles/post/responses/400/content/application~1json/example":{"value":{"message":"The following arguments have invalid values: reason."},"id":"paths/~1accounts~1{number}~1toggles/post/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}~1toggles/post/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access or modify this account."},"id":"paths/~1accounts~1{number}~1toggles/post/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example":{"value":{"reason":"I have moved and no longer wish to use this app."},"id":"paths/~1accounts~1{number}~1deletions/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{number}~1deletions/post/responses/200/content/application~1json/example":{"value":{"message":"The account will be deleted pending review."},"id":"paths/~1accounts~1{number}~1deletions/post/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1deletions/post/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access or modify this account."},"id":"paths/~1accounts~1{number}~1deletions/post/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1sessions/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":5,"entries":[{"open":true,"ip":"90.220.241.159","agent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","started":"2023-06-30 10:35:39","ended":""},{"open":false,"ip":"90.220.241.159","agent":"Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion","started":"2023-01-04 11:23:00","ended":"2023-03-30 09:22:01"}]},"id":"paths/~1accounts~1{number}~1sessions/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1sessions/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1sessions/get/responses/404/content/application~1json/example"},"paths/~1accounts~1{number}~1events/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","host":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"}]},"id":"paths/~1accounts~1{number}~1events/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1events/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1events/get/responses/404/content/application~1json/example"},"paths/~1accounts~1{number}~1tickets/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":15,"entries":[{"serial":"DAWIER-BACK75580348","status":"Issued","issued":"2024-02-21T14:59:18+00:00","redeemed":"N/A","section":{"self":"/events/16993717817996/sections/16993964783416","name":"Backstage","description":"Includes meet and greet with the film's stars."}},{"serial":"DAWIER-VIPV75580348","status":"Redeemed","issued":"2024-02-21T14:59:18+00:00","redeemed":"2024-06-07T19:50:31+00:00","section":{"self":"/events/16993717817996/sections/16993964783416","name":"Backstage","description":"Includes meet and greet with the film's stars."}}]},"id":"paths/~1accounts~1{number}~1tickets/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1tickets/get/responses/400/content/application~1json/example":{"value":{"message":"The following query parameters have invalid values: status, serial."},"id":"paths/~1accounts~1{number}~1tickets/get/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}~1tickets/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1tickets/get/responses/404/content/application~1json/example"},"paths/~1accounts~1{number}~1transfers/get/responses/200/content/application~1json/example":{"value":{"page":2,"records":8,"entries":[{"self":"/transfers/17096551195817","status":"Pending","items":[{"name":"Dawn of the Seven Premier: Backstage","description":"Includes meet and greet with the film's stars.","quantity":2}],"sender":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk"},"recipient":{"self":"/accounts/BI-5A939D5D","number":"BI-5A939D5D","username":"the_butcher","email":"elcapitaine@yahoo.com","firstName":"Billy","lastName":"Butcher"}}]},"id":"paths/~1accounts~1{number}~1transfers/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1transfers/get/responses/400/content/application~1json/example":{"value":{"message":"Your request must specify whether to list transfers sent or received"},"id":"paths/~1accounts~1{number}~1transfers/get/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}~1transfers/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1transfers/get/responses/404/content/application~1json/example"},"paths/~1hosts/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":5,"entries":[{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"}]},"id":"paths/~1hosts/get/responses/200/content/application~1json/example"},"paths/~1hosts/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts/get/responses/404/content/application~1json/example"},"paths/~1hosts/post/requestBody/content/application~1json/example":{"value":{"name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","state":"Saint John","businessNo":"A5585291"},"id":"paths/~1hosts/post/requestBody/content/application~1json/example"},"paths/~1hosts/post/responses/201/content/application~1json/example":{"value":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"id":"paths/~1hosts/post/responses/201/content/application~1json/example"},"paths/~1hosts/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts/post/responses/400/content/application~1json/example"},"paths/~1hosts/post/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Host would violate uniqueness constraints."},"id":"paths/~1hosts/post/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}/get/responses/200/content/application~1json/example":{"value":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"id":"paths/~1hosts~1{host}/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}/get/responses/404/content/application~1json/example":{"value":{"message":"There is presently no host with the given URI."},"id":"paths/~1hosts~1{host}/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}/put/requestBody/content/application~1json/example":{"value":{"name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","state":"Saint John","businessNo":"A5585291"},"id":"paths/~1hosts~1{host}/put/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}/put/responses/200/content/application~1json/example":{"value":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"id":"paths/~1hosts~1{host}/put/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts~1{host}/put/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}/put/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}/put/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}/put/responses/404/content/application~1json/example":{"value":{"message":"There is presently no host with the given URI."},"id":"paths/~1hosts~1{host}/put/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}/put/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Host would violate uniqueness constraints."},"id":"paths/~1hosts~1{host}/put/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}/delete/responses/200/content/application~1json/example":{"value":{"message":"host: /hosts/17724935637423, has been deleted."},"id":"paths/~1hosts~1{host}/delete/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}/delete/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}/delete/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}/delete/responses/404/content/application~1json/example":{"value":{"message":"There is presently no host with the given URI."},"id":"paths/~1hosts~1{host}/delete/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}/delete/responses/409/content/application~1json/example":{"value":{"message":"The requested host is in use and cannot be deleted."},"id":"paths/~1hosts~1{host}/delete/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/hosts/16951985851389/privileges/18294757620193","user":"billy.butcher@fbsa.gov","role":{"name":"Administrator","permissions":["retrieve_host","modify_host","delete_host","list_host_events","create_event"]},"type":"host","resource":16951985851389,"pending":false}]},"id":"paths/~1hosts~1{host}~1privileges/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1privileges/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1privileges/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example":{"value":{"user":"billy.butcher@fbsa.gov","role":"Administrator"},"id":"paths/~1hosts~1{host}~1privileges/post/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/post/responses/201/content/application~1json/example":{"value":{"self":"/hosts/16951985851389/privileges/18294757620193","user":"billy.butcher@fbsa.gov","role":{"name":"Administrator","permissions":["retrieve_host","modify_host","delete_host","list_host_events","create_event"]},"type":"host","resource":16993717817996,"pending":false},"id":"paths/~1hosts~1{host}~1privileges/post/responses/201/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/post/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1privileges/post/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges/post/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Privilege would violate uniqueness constraints."},"id":"paths/~1hosts~1{host}~1privileges/post/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/200/content/application~1json/example":{"value":{"self":"/hosts/16951985851389/privileges/18294757620193","user":"billy.butcher@fbsa.gov","role":{"name":"Administrator","permissions":["retrieve_host","modify_host","delete_host","list_host_events","create_event"]},"type":"host","resource":16993717817996,"pending":false},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/404/content/application~1json/example":{"value":{"message":"There is presently no privilege with the given URI."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example":{"value":{"role":"Administrator"},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/put/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/200/content/application~1json/example":{"value":{"self":"/hosts/16951985851389/privileges/18294757620193","user":"billy.butcher@fbsa.gov","role":{"name":"Administrator","permissions":["retrieve_host","modify_host","delete_host","list_host_events","create_event"]},"type":"host","resource":16993717817996,"pending":false},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/404/content/application~1json/example":{"value":{"message":"There is presently no privilege with the given URI."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/409/content/application~1json/example":{"value":{"message":"A privilege with the Owner role cannot be modified or deleted."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/put/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/200/content/application~1json/example":{"value":{"message":"privilege: /hosts/16951985851389/privileges/18294757620193, has been revoked."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/404/content/application~1json/example":{"value":{"message":"There is presently no privilege with the given URI."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/409/content/application~1json/example":{"value":{"message":"A privilege with the Owner role cannot be modified or deleted."},"id":"paths/~1hosts~1{host}~1privileges~1{privilege}/delete/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1events/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","status":"Pending","venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","popularity":78,"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"}]},"id":"paths/~1hosts~1{host}~1events/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1events/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1events/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example":{"value":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzoAAASRCAYAAAD/zekXAA...","thumbnail":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAB4AAAAQ4CAYAAADo08FDAAAAB..."},"id":"paths/~1hosts~1{host}~1events/post/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1events/post/responses/201/content/application~1json/example":{"value":{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","status":"Pending","venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","popularity":78,"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"id":"paths/~1hosts~1{host}~1events/post/responses/201/content/application~1json/example"},"paths/~1hosts~1{host}~1events/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts~1{host}~1events/post/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1events/post/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1events/post/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/get/responses/200/content/application~1json/example":{"value":{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","status":"Pending","venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","popularity":78,"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"id":"paths/~1hosts~1{host}~1events~1{event}/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/get/responses/404/content/application~1json/example":{"value":{"message":"There is presently no event with the given URI."},"id":"paths/~1hosts~1{host}~1events~1{event}/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example":{"value":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzoAAASRCAYAAAD/zekXAA...","thumbnail":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAB4AAAAQ4CAYAAADo08FDAAAAB..."},"id":"paths/~1hosts~1{host}~1events~1{event}/put/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/put/responses/200/content/application~1json/example":{"value":{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","status":"Pending","venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","popularity":78,"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"id":"paths/~1hosts~1{host}~1events~1{event}/put/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts~1{host}~1events~1{event}/put/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/put/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}/put/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/put/responses/404/content/application~1json/example":{"value":{"message":"There is presently no event with the given URI."},"id":"paths/~1hosts~1{host}~1events~1{event}/put/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/delete/responses/200/content/application~1json/example":{"value":{"message":"event: /events/17728094995512, has been deleted."},"id":"paths/~1hosts~1{host}~1events~1{event}/delete/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/delete/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}/delete/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/delete/responses/404/content/application~1json/example":{"value":{"message":"There is presently no event with the given URI."},"id":"paths/~1hosts~1{host}~1events~1{event}/delete/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}/delete/responses/409/content/application~1json/example":{"value":{"message":"An event cannot be deleted once tickets have been sold."},"id":"paths/~1hosts~1{host}~1events~1{event}/delete/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/submissions/17286027149221","type":"event","resource":"16993717817996","previous":{},"changes":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"note":"New event submission: Dawn of the Seven Premier","status":"Pending"}]},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example":{"value":{"note":"New event submission: Dawn of the Seven Premier"},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/201/content/application~1json/example":{"value":{"self":"/submissions/17286027149221","type":"event","resource":"16993717817996","previous":{},"changes":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"note":"New event submission: Dawn of the Seven Premier","status":"Pending"},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/201/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/409/content/application~1json/example":{"value":{"message":"Pending changes have already been submitted for review, and are awaiting approval."},"id":"paths/~1hosts~1{host}~1events~1{event}~1submissions/post/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/publications/17286027149221","changes":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"publish_at":"2026-05-21T14:30:00Z"}]},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example":{"value":{"publish_at":"2026-05-21T14:30:00Z"},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/post/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/201/content/application~1json/example":{"value":{"self":"/publications/17286027149221","changes":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"publish_at":"2026-05-21T14:30:00Z"},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/201/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/409/content/application~1json/example":{"value":{"message":"Pending changes must be submitted and approved before publication."},"id":"paths/~1hosts~1{host}~1events~1{event}~1publications/post/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"capacity":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","bundle":[{"description":"Dawn of the Seven Premier","event":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":2,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"capacity":10,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","bundle":[{"description":"Dawn of the Seven Premier","event":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","purchase_limit":1,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[]}]}]},"id":"paths/~1hosts~1{host}~1tiers/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1tiers/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1tiers/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example":{"value":{"name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"capacity":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":75},{"id":19420571582519,"share":25}],"artwork":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzoAAASRCAYAAAD/zekXAA...","unit_size":1,"purchase_limit":2,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[18191406121236]},"id":"paths/~1hosts~1{host}~1tiers/post/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/post/responses/201/content/application~1json/example":{"value":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"capacity":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":75},{"id":19420571582519,"share":25}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","unit_size":1,"purchase_limit":2,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"capacity":10,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","purchase_limit":1,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[]}],"gross_sales":100000,"tickets_sold":200},"id":"paths/~1hosts~1{host}~1tiers/post/responses/201/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/post/responses/400/content/application~1json/example":{"value":{"message":"The shares in a tier's bundle must total 100."},"id":"paths/~1hosts~1{host}~1tiers/post/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/post/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1tiers/post/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers/post/responses/409/content/application~1json/example":{"value":{"message":"One or more of the specified events already has a tier with the given name."},"id":"paths/~1hosts~1{host}~1tiers/post/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/200/content/application~1json/example":{"value":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"capacity":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":75},{"id":19420571582519,"share":25}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","unit_size":1,"purchase_limit":2,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"capacity":10,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","purchase_limit":1,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[]}],"gross_sales":100000,"tickets_sold":200},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/404/content/application~1json/example":{"value":{"message":"There is presently no tier with the given URI."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example":{"value":{"name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"capacity":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":75},{"id":19420571582519,"share":25}],"artwork":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzoAAASRCAYAAAD/zekXAA...","unit_size":1,"purchase_limit":2,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[18191406121236]},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/put/requestBody/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/200/content/application~1json/example":{"value":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"capacity":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":75},{"id":19420571582519,"share":25}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","unit_size":1,"purchase_limit":2,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"capacity":10,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","purchase_limit":1,"purchase_note":"Your all set. Remember to give the codeword HOMELANDER when coming backstage.","complimentary":false,"transferable":false,"upgrades":[]}],"gross_sales":100000,"tickets_sold":200},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/400/content/application~1json/example":{"value":{"message":"The shares in a tier's bundle must total 100."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/400/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/404/content/application~1json/example":{"value":{"message":"There is presently no tier with the given URI."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/409/content/application~1json/example":{"value":{"message":"A tier with issued tickets can no longer be modified or deleted."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/put/responses/409/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/200/content/application~1json/example":{"value":{"message":"Tier: /tier/17728094995512, has been deleted."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/404/content/application~1json/example":{"value":{"message":"There is presently no tier with the given URI."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/409/content/application~1json/example":{"value":{"message":"A tier with issued tickets can no longer be modified or deleted."},"id":"paths/~1hosts~1{host}~1tiers~1{tier}/delete/responses/409/content/application~1json/example"},"paths/~1events/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","host":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"}]},"id":"paths/~1events/get/responses/200/content/application~1json/example"},"paths/~1events/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1events/get/responses/404/content/application~1json/example"},"paths/~1events~1{event}/get/responses/200/content/application~1json/example":{"value":{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","host":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"id":"paths/~1events~1{event}/get/responses/200/content/application~1json/example"},"paths/~1events~1{event}/get/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access this unlisted event."},"id":"paths/~1events~1{event}/get/responses/403/content/application~1json/example"},"paths/~1events~1{event}/get/responses/404/content/application~1json/example":{"value":{"message":"There is presently no event with the given URI."},"id":"paths/~1events~1{event}/get/responses/404/content/application~1json/example"},"paths/~1events~1{event}~1tiers/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","unit_size":1,"upgrades":[]}]}]},"id":"paths/~1events~1{event}~1tiers/get/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1tiers/get/responses/403/content/application~1json/example":{"value":{"message":"You are not authorised to access this unlisted event."},"id":"paths/~1events~1{event}~1tiers/get/responses/403/content/application~1json/example"},"paths/~1events~1{event}~1tiers/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1events~1{event}~1tiers/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1sales/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/sales/19483205968275","recorded":"2026-08-03T21:11:00Z","order":"E8D946240203","event":{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","host":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"tier":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","unit_size":1,"upgrades":[]}]},"customer":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's","preferences":"/accounts/MO-6A39EE8D/preferences"},"quantity":2,"total":1000,"status":"confirmed","payment":{"method":"card","cardholder":"Marvin M. Milk","digits":"5555","type":"mc"}}]},"id":"paths/~1hosts~1{host}~1sales/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1sales/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified host or its resources."},"id":"paths/~1hosts~1{host}~1sales/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1sales/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1sales/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1statistics/get/responses/200/content/application~1json/example":{"value":{"start":"2025-08-01 00:00:00","end":"2026-08-01 00:00:00","gross_sales":100000,"tickets_sold":200,"breakdown":[{"interval":"2025","gross_sales":20000,"tickets_sold":40},{"interval":"2026","gross_sales":80000,"tickets_sold":160}]},"id":"paths/~1hosts~1{host}~1statistics/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1statistics/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be located."},"id":"paths/~1hosts~1{host}~1statistics/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/sales/19483205968275","recorded":"2026-08-03T21:11:00Z","order":"E8D946240203","event":{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","category":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"subcategory":{"self":"/categories/17720402945929","name":"Boat Cruise","subcategories":[]},"start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","host":{"self":"/hosts/16951985851389","name":"The Boys Entertainment","contact":"Billy Butcher","email":"billy.butcher@fbsa.gov","description":"Premier events for supes of all ages","phone":"+1 (268) 555 8075","website":"https://theboys.net","country":"Antigua and Barbuda","firstAddressLine":"Wireless Road","secondAddressLine":"Clare Hall","city":"St. John's","district":"Saint John","businessNo":"A5585291","events":"/hosts/16951985851389/events"},"venue":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"disclaimer":"","tags":["homelander","queen maeve","the deep","A-Train"],"published":"2024-02-17T07:32:00Z","banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"tier":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[{"self":"/tiers/18191406121236","name":"All-Access Pass","description":"The full VIP experience, including the week leading up to the show.","price":500,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/18191406121236.jpeg","unit_size":1,"upgrades":[]}]},"customer":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","role":"customer","verified":false,"activated":true,"firstName":"Marvin","lastName":"Milk","title":"Mr","dateOfBirth":"1974-09-14","phone":"+1 (268) 555 0123","country":"Antigua and Barbuda","firstAddressLine":"Jennings New Extension","secondAddressLine":"","city":"Jennings","state":"Saint Mary's","preferences":"/accounts/MO-6A39EE8D/preferences"},"quantity":2,"total":1000,"status":"confirmed","payment":{"method":"card","cardholder":"Marvin M. Milk","digits":"5555","type":"mc"}}]},"id":"paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/403/content/application~1json/example":{"value":{"message":"You are restricted from perfoming this operation on the specified event."},"id":"paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/403/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1hosts~1{host}~1events~1{event}~1sales/get/responses/404/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/200/content/application~1json/example":{"value":{"start":"2025-08-01 00:00:00","end":"2026-08-01 00:00:00","gross_sales":100000,"tickets_sold":200,"breakdown":[{"interval":"2025","gross_sales":20000,"tickets_sold":40},{"interval":"2026","gross_sales":80000,"tickets_sold":160}]},"id":"paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/200/content/application~1json/example"},"paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be located."},"id":"paths/~1hosts~1{host}~1events~1{event}~1statistics/get/responses/404/content/application~1json/example"},"paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example":{"value":{"sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},"id":"paths/~1events~1{event}~1tokens/post/requestBody/content/application~1json/example"},"paths/~1events~1{event}~1tokens/post/responses/201/content/application~1json/example":{"value":{"self":"/events/16993717817996/tokens/17370490770235","code":"A0F9GG8D","global":true,"sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},"id":"paths/~1events~1{event}~1tokens/post/responses/201/content/application~1json/example"},"paths/~1events~1{event}~1tokens/post/responses/400/content/application~1json/example":{"value":{"message":"One or more of the specified sections does not belong to this event."},"id":"paths/~1events~1{event}~1tokens/post/responses/400/content/application~1json/example"},"paths/~1events~1{event}~1tokens/get/responses/200/content/application~1json/example":{"value":{"total":2,"page":1,"records":25,"entries":[{"self":"/events/16993717817996/tokens/17370490770235","code":"A0F9GG8D","global":true,"sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},{"self":"/events/16993717817996/tokens/17370490774288","code":"91JKC83A","global":false,"sections":["/events/16993717817996/sections/16993964783416"]}]},"id":"paths/~1events~1{event}~1tokens/get/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1tokens/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1events~1{event}~1tokens/get/responses/404/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/get/responses/200/content/application~1json/example":{"value":{"self":"/events/16993717817996/tokens/17370490770235","code":"A0F9GG8D","global":true,"sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},"id":"paths/~1events~1{event}~1tokens~1{token}/get/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be located."},"id":"paths/~1events~1{event}~1tokens~1{token}/get/responses/404/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example":{"value":{"sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},"id":"paths/~1events~1{event}~1tokens~1{token}/put/requestBody/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/put/responses/200/content/application~1json/example":{"value":{"self":"/events/16993717817996/tokens/17370490770235","code":"A0F9GG8D","global":true,"sections":["/events/16993717817996/sections/16993964783416","/events/16993717817996/sections/16993964783417"]},"id":"paths/~1events~1{event}~1tokens~1{token}/put/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/put/responses/400/content/application~1json/example":{"value":{"message":"One or more of the specified sections does not belong to this event."},"id":"paths/~1events~1{event}~1tokens~1{token}/put/responses/400/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/put/responses/409/content/application~1json/example":{"value":{"message":"The global admission token cannot be modified or invalidated."},"id":"paths/~1events~1{event}~1tokens~1{token}/put/responses/409/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/delete/responses/200/content/application~1json/example":{"value":{"message":"Token: /events/16993717817996/tokens/17370490770235 has been deleted."},"id":"paths/~1events~1{event}~1tokens~1{token}/delete/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1tokens~1{token}/delete/responses/409/content/application~1json/example":{"value":{"message":"The global admission token cannot be modified or invalidated."},"id":"paths/~1events~1{event}~1tokens~1{token}/delete/responses/409/content/application~1json/example"},"paths/~1events~1{event}~1tickets/get/responses/200/content/application~1json/example":{"value":{"page":17,"records":914,"entries":[{"serial":"DAWIER-BACK75580348","status":"Issued","section":{"self":"/events/16993717817996/sections/16993964783416","name":"Backstage","description":"Includes meet and greet with the film's stars."},"owner":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk"},"issued":"2024-02-21T14:59:18+00:00","redeemed":"N/A"}]},"id":"paths/~1events~1{event}~1tickets/get/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1tickets/get/responses/403/content/application~1json/example":{"value":{"message":"The admission token is not valid for this event."},"id":"paths/~1events~1{event}~1tickets/get/responses/403/content/application~1json/example"},"paths/~1events~1{event}~1tickets/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1events~1{event}~1tickets/get/responses/404/content/application~1json/example"},"paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example":{"value":{"redeemer":"Butcher","device":"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36...","serials":["DAWIER-BACK75580348","DAWIER-VIPV37536946","DAWIER-BACK75580348"]},"id":"paths/~1events~1{event}~1admissions/post/requestBody/content/application~1json/example"},"paths/~1events~1{event}~1admissions/post/responses/201/content/application~1json/example":{"value":[{"redeemer":"Butcher","device":"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36...","ticket":"DAWIER-BACK75580348","patron":{"username":"mothers.milk","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk"},"section":{"self":"/events/16993717817996/sections/16993964783416","name":"Backstage","description":"Includes meet and greet with the film's stars."},"admitted":"2024-03-01T10:59:56+00:00"},{"redeemer":"Butcher","device":"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36...","ticket":"DAWIER-VIPV37536946","patron":{"username":"the_butcher","email":"billy.butcher@theboys.com","firstName":"Billy","lastName":"Butched"},"section":{"self":"/events/16993717817996/sections/4829429647013942","name":"VIP","description":"All-inclusive food and drinks."},"admitted":"2024-03-01T10:59:56+00:00"}],"id":"paths/~1events~1{event}~1admissions/post/responses/201/content/application~1json/example"},"paths/~1events~1{event}~1admissions/post/responses/400/content/application~1json/example":{"value":{"message":"None of the provided ticket serials grants admission to this event"},"id":"paths/~1events~1{event}~1admissions/post/responses/400/content/application~1json/example"},"paths/~1events~1{event}~1admissions/post/responses/403/content/application~1json/example":{"value":{"message":"The admission token is not valid for this event."},"id":"paths/~1events~1{event}~1admissions/post/responses/403/content/application~1json/example"},"paths/~1events~1{event}~1admissions/get/responses/200/content/application~1json/example":{"value":{"page":3,"records":2,"entries":[{"redeemer":"Butcher","device":"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36...","ticket":"DAWIER-BACK75580348","patron":{"username":"mothers.milk","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk"},"section":{"self":"/events/16993717817996/sections/16993964783416","name":"Backstage","description":"Includes meet and greet with the film's stars."},"admitted":"2024-03-01T10:59:56+00:00"},{"redeemer":"Butcher","device":"Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36...","ticket":"DAWIER-VIPV37536946","patron":{"username":"the_butcher","email":"billy.butcher@theboys.com","firstName":"Billy","lastName":"Butched"},"section":{"self":"/events/16993717817996/sections/4829429647013942","name":"VIP","description":"All-inclusive food and drinks."},"admitted":"2024-03-01T10:59:56+00:00"}]},"id":"paths/~1events~1{event}~1admissions/get/responses/200/content/application~1json/example"},"paths/~1events~1{event}~1admissions/get/responses/403/content/application~1json/example":{"value":{"message":"The admission token is not valid for this event."},"id":"paths/~1events~1{event}~1admissions/get/responses/403/content/application~1json/example"},"paths/~1events~1{event}~1admissions/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1events~1{event}~1admissions/get/responses/404/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":10,"entries":[{"self":"/orders/E8D946240203","number":"E8D946240203","status":"Placed","placed":"2024-02-03T23:22:31+00:00","subtotal":140,"fees":3.96,"total":143.96,"items":[{"tier":{"self":"/tiers/19381758318131","name":"General Admission","description":"General Admission to the premier screening of the movie of the year.","price":20,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[]},"quantity":2},{"tier":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[]},"quantity":2}],"events":[{"self":"/events/16993717817996","title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"}],"payment":{"uri":"https://payments.frubipay.com/1234567890","status":"Pending","method":{"cardholder":"","card_type":"","card_digits":""}}}]},"id":"paths/~1accounts~1{number}~1orders/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1accounts~1{number}~1orders/get/responses/404/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example":{"value":{"items":[{"tier":16993964783416,"quantity":2},{"tier":16971671292759,"quantity":2}]},"id":"paths/~1accounts~1{number}~1orders/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/post/responses/201/content/application~1json/example":{"value":{"self":"/orders/E8D946240203","number":"E8D946240203","status":"Placed","placed":"2024-02-03T23:22:31+00:00","subtotal":140,"fees":3.96,"total":143.96,"items":[{"tier":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[]},"quantity":2}],"payment":{"uri":"https://payments.frubipay.com/1234567890","status":"Pending","method":{"cardholder":"","card_type":"","card_digits":""}}},"id":"paths/~1accounts~1{number}~1orders/post/responses/201/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/post/responses/400/content/application~1json/example":{"value":{"message":"The specified tier does not have sufficient capacity remaining"},"id":"paths/~1accounts~1{number}~1orders/post/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/post/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to access orders on behalf of the ordering customer."},"id":"paths/~1accounts~1{number}~1orders/post/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1orders/post/responses/409/content/application~1json/example":{"value":{"message":"You may not purchase tiers for an unpublished event."},"id":"paths/~1accounts~1{number}~1orders/post/responses/409/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}/get/responses/200/content/application~1json/example":{"value":{"self":"/orders/E8D946240203","number":"E8D946240203","status":"Placed","placed":"2024-02-03T23:22:31+00:00","subtotal":140,"fees":3.96,"total":143.96,"items":[{"tier":{"self":"/tiers/19381758318131","name":"Backstage Pass","description":"Gain exclusive access to meet the Supes and hang out after the show.","price":299.9,"available_from":"2025-05-02T21:00:00Z","available_to":"2025-07-01T00:00:00Z","events":[{"id":16993717817996,"share":100}],"artwork":"http://localhost/tier/artwork/19381758318131.jpeg","purchase_limit":10,"unit_size":2,"upgrades":[]},"quantity":2}],"payment":{"uri":"https://payments.frubipay.com/1234567890","status":"Pending","method":{"cardholder":"","card_type":"","card_digits":""}}},"id":"paths/~1accounts~1{number}~1orders~1{order}/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}/get/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to access orders on behalf of the ordering customer."},"id":"paths/~1accounts~1{number}~1orders~1{order}/get/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}/delete/responses/200/content/application~1json/example":{"value":{"message":"Order: /orders/E8D946240203, has been cancelled successfully."},"id":"paths/~1accounts~1{number}~1orders~1{order}/delete/responses/200/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}/delete/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to access orders on behalf of the ordering customer."},"id":"paths/~1accounts~1{number}~1orders~1{order}/delete/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}/delete/responses/409/content/application~1json/example":{"value":{"message":"A timed out order cannot be cancelled."},"id":"paths/~1accounts~1{number}~1orders~1{order}/delete/responses/409/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example":{"value":{"number":"5555555555555555","cvv":123,"expiryDate":"12/30","name":"Marvin M. Milk","email":"marvin.milk@usmc.gov","phone":"+1 (268) 555 0123","address1":"Hermitage Rd.","address2":"Jennings New Extension","city":"Jennings","district":"Saint Mary's","country":"Antigua and Barbuda"},"id":"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/requestBody/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/201/content/application~1json/example":{"value":{"date":"2024-02-19T17:30:08","amount":101.99,"status":"Authorised"},"id":"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/201/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/400/content/application~1json/example":{"value":{"message":"The following arguments are required, but have not been supplied: cvv, expiryDate"},"id":"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/400/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to make payment on behalf of the ordering customer."},"id":"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/403/content/application~1json/example"},"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/409/content/application~1json/example":{"value":{"message":"You cannot pay for a Fulfilled order."},"id":"paths/~1accounts~1{number}~1orders~1{order}~1payments/post/responses/409/content/application~1json/example"},"paths/~1transfers/post/requestBody/content/application~1json/example":{"value":{"sender":"MO-6A39EE8D","recipient":"billy.butcher","tickets":{"/events/16993717817996/sections/16993964783416":2}},"id":"paths/~1transfers/post/requestBody/content/application~1json/example"},"paths/~1transfers/post/responses/201/content/application~1json/example":{"value":{"self":"/transfers/17096551195817","status":"Pending","tickets":[{"name":"Dawn of the Seven Premier: Backstage","description":"Includes meet and greet with the film's stars.","quantity":2}],"initiated":"2025-11-13T12:16:57+00:00","sender":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk"},"recipient":{"self":"/accounts/BI-5A939D5D","number":"BI-5A939D5D","username":"the_butcher","email":"elcapitaine@yahoo.com","firstName":"Billy","lastName":"Butcher"},"claims":"/transfers/17096551195817/claims"},"id":"paths/~1transfers/post/responses/201/content/application~1json/example"},"paths/~1transfers/post/responses/400/content/application~1json/example":{"value":{"message":"The sender does not hold sufficient itckets in their wallet to complete this transfer."},"id":"paths/~1transfers/post/responses/400/content/application~1json/example"},"paths/~1transfers/post/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to initiate transfers on behalf of the sender."},"id":"paths/~1transfers/post/responses/403/content/application~1json/example"},"paths/~1transfers/post/responses/404/content/application~1json/example":{"value":{"message":"The requested account could not be located"},"id":"paths/~1transfers/post/responses/404/content/application~1json/example"},"paths/~1transfers/post/responses/409/content/application~1json/example":{"value":{"message":"A sender cannot transfer tickets to themselves."},"id":"paths/~1transfers/post/responses/409/content/application~1json/example"},"paths/~1transfers~1{transfer}/get/responses/200/content/application~1json/example":{"value":{"self":"/transfers/17096551195817","status":"Pending","tickets":[{"name":"Dawn of the Seven Premier: Backstage","description":"Includes meet and greet with the film's stars.","quantity":2}],"initiated":"2025-11-13T12:16:57+00:00","sender":{"self":"/accounts/MO-6A39EE8D","number":"MO-6A39EE8D","username":"mothers.milk","email":"marvin.milk@usmc.gov","firstName":"Marvin","lastName":"Milk"},"recipient":{"self":"/accounts/BI-5A939D5D","number":"BI-5A939D5D","username":"the_butcher","email":"elcapitaine@yahoo.com","firstName":"Billy","lastName":"Butcher"},"claims":"/transfers/17096551195817/claims"},"id":"paths/~1transfers~1{transfer}/get/responses/200/content/application~1json/example"},"paths/~1transfers~1{transfer}/get/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to initiate transfers on behalf of the sender."},"id":"paths/~1transfers~1{transfer}/get/responses/403/content/application~1json/example"},"paths/~1transfers~1{transfer}/delete/responses/200/content/application~1json/example":{"value":{"message":"Transfer: /transfers/17096551195817, has been cancelled successfully."},"id":"paths/~1transfers~1{transfer}/delete/responses/200/content/application~1json/example"},"paths/~1transfers~1{transfer}/delete/responses/403/content/application~1json/example":{"value":{"message":"This account is not permitted to initiate transfers on behalf of the sender."},"id":"paths/~1transfers~1{transfer}/delete/responses/403/content/application~1json/example"},"paths/~1transfers~1{transfer}/delete/responses/409/content/application~1json/example":{"value":{"message":"A Cancelled transfer cannot be cancelled."},"id":"paths/~1transfers~1{transfer}/delete/responses/409/content/application~1json/example"},"paths/~1transfers~1{transfer}~1claims/post/responses/201/content/application~1json/example":{"value":{"date":"2024-03-05 21:56:09","claimant":"Billy Butcher (the_butcher)","success":true},"id":"paths/~1transfers~1{transfer}~1claims/post/responses/201/content/application~1json/example"},"paths/~1transfers~1{transfer}~1claims/post/responses/403/content/application~1json/example":{"value":{"message":"Only a transfer's recipient can claim a transfer."},"id":"paths/~1transfers~1{transfer}~1claims/post/responses/403/content/application~1json/example"},"paths/~1transfers~1{transfer}~1claims/post/responses/409/content/application~1json/example":{"value":{"message":"This transfer can no longer be claimed."},"id":"paths/~1transfers~1{transfer}~1claims/post/responses/409/content/application~1json/example"},"paths/~1regions/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},{"self":"/regions/159428147942752","name":"Manhattan","country":"United States of America","district":"New York","city":"Manhattan","icon":"https://restfulcountries.com/assets/images/flags/United-States-of-America.png"}]},"id":"paths/~1regions/get/responses/200/content/application~1json/example"},"paths/~1regions/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1regions/get/responses/404/content/application~1json/example"},"paths/~1regions/post/requestBody/content/application~1json/example":{"value":{"name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":""},"id":"paths/~1regions/post/requestBody/content/application~1json/example"},"paths/~1regions/post/responses/201/content/application~1json/example":{"value":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"id":"paths/~1regions/post/responses/201/content/application~1json/example"},"paths/~1regions/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1regions/post/responses/400/content/application~1json/example"},"paths/~1regions/post/responses/409/content/application~1json/example":{"value":{"error":"Creating the requested Region would violate uniqueness constraints."},"id":"paths/~1regions/post/responses/409/content/application~1json/example"},"paths/~1regions~1{region}/get/responses/200/content/application~1json/example":{"value":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"id":"paths/~1regions~1{region}/get/responses/200/content/application~1json/example"},"paths/~1regions~1{region}/get/responses/404/content/application~1json/example":{"value":{"error":"There is presently no region with the given URI."},"id":"paths/~1regions~1{region}/get/responses/404/content/application~1json/example"},"paths/~1regions~1{region}/put/requestBody/content/application~1json/example":{"value":{"name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":""},"id":"paths/~1regions~1{region}/put/requestBody/content/application~1json/example"},"paths/~1regions~1{region}/put/responses/200/content/application~1json/example":{"value":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"id":"paths/~1regions~1{region}/put/responses/200/content/application~1json/example"},"paths/~1regions~1{region}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1regions~1{region}/put/responses/400/content/application~1json/example"},"paths/~1regions~1{region}/put/responses/409/content/application~1json/example":{"value":{"error":"Creating the requested Region would violate uniqueness constraints."},"id":"paths/~1regions~1{region}/put/responses/409/content/application~1json/example"},"paths/~1regions~1{region}/delete/responses/200/content/application~1json/example":{"value":{"message":"Region: /regions/159428147942752, has been deleted."},"id":"paths/~1regions~1{region}/delete/responses/200/content/application~1json/example"},"paths/~1regions~1{region}/delete/responses/409/content/application~1json/example":{"value":{"error":"The requested region is in use and cannot be deleted."},"id":"paths/~1regions~1{region}/delete/responses/409/content/application~1json/example"},"paths/~1venues/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="}]},"id":"paths/~1venues/get/responses/200/content/application~1json/example"},"paths/~1venues/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1venues/get/responses/404/content/application~1json/example"},"paths/~1venues/post/requestBody/content/application~1json/example":{"value":{"name":"Vought Tower","region":"19290238432215","longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York"},"id":"paths/~1venues/post/requestBody/content/application~1json/example"},"paths/~1venues/post/responses/201/content/application~1json/example":{"value":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"id":"paths/~1venues/post/responses/201/content/application~1json/example"},"paths/~1venues/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1venues/post/responses/400/content/application~1json/example"},"paths/~1venues/post/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Venue would violate uniqueness constraints."},"id":"paths/~1venues/post/responses/409/content/application~1json/example"},"paths/~1venues~1{venue}/get/responses/200/content/application~1json/example":{"value":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"id":"paths/~1venues~1{venue}/get/responses/200/content/application~1json/example"},"paths/~1venues~1{venue}/get/responses/404/content/application~1json/example":{"value":{"error":"There is presently no venue with the given URI."},"id":"paths/~1venues~1{venue}/get/responses/404/content/application~1json/example"},"paths/~1venues~1{venue}/put/requestBody/content/application~1json/example":{"value":{"name":"Vought Tower","region":"19290238432215","longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York"},"id":"paths/~1venues~1{venue}/put/requestBody/content/application~1json/example"},"paths/~1venues~1{venue}/put/responses/200/content/application~1json/example":{"value":{"self":"/venues/16878146473429","name":"Vought Tower","region":{"self":"/regions/19290238432215","name":"Antigua and Barbuda","country":"Antigua and Barbuda","district":"","city":"","icon":"https://restfulcountries.com/assets/images/flags/Antigua-And-Barbuda.png"},"longitude":-73.99214,"latitude":40.75518,"address":"7th Ave, Manhattan, New York","map":"https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="},"id":"paths/~1venues~1{venue}/put/responses/200/content/application~1json/example"},"paths/~1venues~1{venue}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1venues~1{venue}/put/responses/400/content/application~1json/example"},"paths/~1venues~1{venue}/put/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Venue would violate uniqueness constraints."},"id":"paths/~1venues~1{venue}/put/responses/409/content/application~1json/example"},"paths/~1venues~1{venue}/delete/responses/200/content/application~1json/example":{"value":{"message":"venue: /venues/17722058266303, has been deleted."},"id":"paths/~1venues~1{venue}/delete/responses/200/content/application~1json/example"},"paths/~1venues~1{venue}/delete/responses/409/content/application~1json/example":{"value":{"message":"The requested venue is in use and cannot be deleted."},"id":"paths/~1venues~1{venue}/delete/responses/409/content/application~1json/example"},"paths/~1categories/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/categories/16878141745207","name":"Party","subcategories":["Boat Cruise","House Party","Wedding"]},{"self":"/categories/16972381860264","name":"Sports","subcategories":["Cricket","Basketball"]}]},"id":"paths/~1categories/get/responses/200/content/application~1json/example"},"paths/~1categories/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1categories/get/responses/404/content/application~1json/example"},"paths/~1categories/post/requestBody/content/application~1json/example":{"value":{"name":"Party","subcategories":["Boat Cruise","House Party","Wedding"]},"id":"paths/~1categories/post/requestBody/content/application~1json/example"},"paths/~1categories/post/responses/201/content/application~1json/example":{"value":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"id":"paths/~1categories/post/responses/201/content/application~1json/example"},"paths/~1categories/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1categories/post/responses/400/content/application~1json/example"},"paths/~1categories/post/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Category would violate uniqueness constraints."},"id":"paths/~1categories/post/responses/409/content/application~1json/example"},"paths/~1categories~1{category}/get/responses/200/content/application~1json/example":{"value":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"id":"paths/~1categories~1{category}/get/responses/200/content/application~1json/example"},"paths/~1categories~1{category}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be located."},"id":"paths/~1categories~1{category}/get/responses/404/content/application~1json/example"},"paths/~1categories~1{category}/put/requestBody/content/application~1json/example":{"value":{"name":"Party","subcategories":["Boat Cruise","House Party","Wedding"]},"id":"paths/~1categories~1{category}/put/requestBody/content/application~1json/example"},"paths/~1categories~1{category}/put/responses/200/content/application~1json/example":{"value":{"self":"/categories/16878141745207","name":"Party","subcategories":[{"self":"/categories/17720402945929","name":"Boat Cruise"},{"self":"/categories/17720402945927","name":"House Party"},{"self":"/categories/17720402914950","name":"Wedding"}]},"id":"paths/~1categories~1{category}/put/responses/200/content/application~1json/example"},"paths/~1categories~1{category}/put/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1categories~1{category}/put/responses/400/content/application~1json/example"},"paths/~1categories~1{category}/put/responses/409/content/application~1json/example":{"value":{"message":"Creating the requested Category would violate uniqueness constraints."},"id":"paths/~1categories~1{category}/put/responses/409/content/application~1json/example"},"paths/~1categories~1{category}/delete/responses/200/content/application~1json/example":{"value":{"message":"Category: /categories/16972381860264, has been deleted."},"id":"paths/~1categories~1{category}/delete/responses/200/content/application~1json/example"},"paths/~1categories~1{category}/delete/responses/409/content/application~1json/example":{"value":{"message":"The requested category is in use and cannot be deleted."},"id":"paths/~1categories~1{category}/delete/responses/409/content/application~1json/example"},"paths/~1submissions/get/responses/200/content/application~1json/example":{"value":{"page":1,"records":25,"entries":[{"self":"/submissions/17286027149221","type":"event","resource":"16993717817996","previous":{},"changes":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"note":"New event submission: Dawn of the Seven Premier","status":"Pending"}]},"id":"paths/~1submissions/get/responses/200/content/application~1json/example"},"paths/~1submissions/get/responses/404/content/application~1json/example":{"value":{"error":"The specified page does not exist for the given records per page."},"id":"paths/~1submissions/get/responses/404/content/application~1json/example"},"paths/~1submissions~1{submission}/get/responses/200/content/application~1json/example":{"value":{"self":"/submissions/17286027149221","type":"event","resource":"16993717817996","previous":{},"changes":{"title":"Dawn of the Seven Premier","description":"World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n","type":"Standard","public":true,"category":"/categories/16878141745207","subcategory":"Premier","start":"2024-06-07T20:00:00Z","end":"2024-06-07T23:00:00Z","venue":"/venues/16878146473429","disclaimer":"Attend at your own risk","tags":["homelander","queen maeve","the deep","A-Train"],"banner":"http://localhost/media/16993717817996-banner.jpeg","thumbnail":"http://localhost/media/16993717817996-thumbnail.jpeg"},"note":"New event submission: Dawn of the Seven Premier","status":"Pending"},"id":"paths/~1submissions~1{submission}/get/responses/200/content/application~1json/example"},"paths/~1submissions~1{submission}/get/responses/404/content/application~1json/example":{"value":{"message":"There is presently no submission with the given URI."},"id":"paths/~1submissions~1{submission}/get/responses/404/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/get/responses/200/content/application~1json/example":{"value":{"approved":false,"note":"The submitted content violates TiceTing's content guidelines."},"id":"paths/~1submissions~1{submission}~1decision/get/responses/200/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/get/responses/404/content/application~1json/example":{"value":{"message":"A decision has not yet been taken on this submission."},"id":"paths/~1submissions~1{submission}~1decision/get/responses/404/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example":{"value":{"approved":false,"note":"The submitted content violates TiceTing's content guidelines."},"id":"paths/~1submissions~1{submission}~1decision/post/requestBody/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/post/responses/200/content/application~1json/example":{"value":{"approved":false,"note":"The submitted content violates TiceTing's content guidelines."},"id":"paths/~1submissions~1{submission}~1decision/post/responses/200/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/post/responses/400/content/application~1json/example":{"value":{"error":"Your request payload is invalid. Please ensure you have included all required fields and values are well-formed."},"id":"paths/~1submissions~1{submission}~1decision/post/responses/400/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/post/responses/404/content/application~1json/example":{"value":{"message":"There is presently no submission with the given URI."},"id":"paths/~1submissions~1{submission}~1decision/post/responses/404/content/application~1json/example"},"paths/~1submissions~1{submission}~1decision/post/responses/409/content/application~1json/example":{"value":{"message":"A decision has already been taken on this submission."},"id":"paths/~1submissions~1{submission}~1decision/post/responses/409/content/application~1json/example"},"paths/~1countries/get/responses/200/content/application~1json/example":{"value":{"self":"/countries","countries":["Afghanistan","Albania","Algeria","Andorra","Angola","Antigua And Barbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","..."]},"id":"paths/~1countries/get/responses/200/content/application~1json/example"},"paths/~1countries/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be located."},"id":"paths/~1countries/get/responses/404/content/application~1json/example"}},"securitySchemeStore":{"SessionKey":{"id":"SessionKey","type":"apiKey","in":"header","paramName":"X-API-Key"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://qa.ticketingevents.com/v3","description":"QA Server"},{"url":"https://api.ticketingevents.com/v3","description":"Production Server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"TickeTing REST API v3 Reference","description":"# Introduction\nThe TickeTing REST API v3 allows developers to integrate with the TickeTing \nplatform, from creating hosts and events to buying and transferring tickets.\nThis reference document will walk you through authenticating against the API\nand the full list of available endpoints, their permissions and functionality.\n\n# Authentication\nThe TickeTing API uses API keys to authenticate requests. You must provide a \nvalid API Key in the X-API-Key header of each request you make. There are two\nways to get a valid API Key:\n\n1. Start a session with a valid TickeTing username and password (this gives\naccess based on the user's permissions).\n\n2. Secure an integration key from a system administrator. Integration keys grant an\naccess level determined by the administrator on creation.\n\nSession Authentication and Integration Keys are covered in the\n[Authentication](#tag/Session-Management \"Authentication\") section of this reference.\n\n### Example Request Header\n\n~~~\nX-API-Key: a9427bf35dd3d3011a1277c9c344ae07\n~~~\n\n### Authentication Errors\n\nOmitting the X-API-Key Header from your request or specifying an empty value, will result in\nthe following 401 error response.\n\n~~~\n{\n  \"message\": \"Your request could not be authenticated.\"\n}\n~~~\n\nIf an invalid X-API-Key value is provided, or the provided key is valid, but does not have\npermission to access the requested resource, the following 403 error response is sent.\n\n~~~\n{\n  \"message\": \"You are restricted from accessing this resource.\"\n}\n~~~\n\n# Client Version\nAll requests to the API must include the version of the API they wish to integrate with.\nThis ensures compatability with the server. This is done by including the X-Client-Version\nheader in every request along with the expected API version. In this way the server can\nindicate when a client must upgrade to avoid breaking changes.\n\n### Example Request Header\n\n~~~\nX-Client-Version: 3.0.0\n~~~\n\n### Client Version Errors\n\nIf the X-Client-Version header is omitted from your request, or the provided version does\nnot meet the minimum required by the API, the following 412 error response\nis sent.\n\n~~~\n{\n    \"error\": \"Please upgrade your client to complete this request\"\n}\n~~~\n\n# Error Responses\n\n### 404 Errors\n\nRequests to the API can result in a 404 error for two reasons:\n\n1.  The endpoint you are trying to access does not exist, in which case you will see the\n    following response:\n  \n    ~~~\n    {\n        \"message\": \"The requested endpoint /invalid/endpoint does not exist on this server.\"\n    }\n    ~~~\n\n2.  The endpoint you are requesting exists, but a resource cannot be located using the\n    given URI. For example, trying to access an event resource with a non-existant ID such\n    as /events/0000000 will result in the following response:\n  \n    ~~~\n    {\n        \"error\": \"There is presently no resource with the given URI.\"\n    }\n    ~~~\n\n### Server Errors\n\nThis version of the API is still under development and there may be bugs and runtime errors\nencountered while processing your request. In these cases, a 500 error response will be sent\nwith the message below. If such a message is received, please contact a\n[system administrator](mailto:dev@ticketingevents.com \"Administrator Contact\") with the details\nof your request (endpoint, method, headers and payload), so they may reproduce and resolve the\nissue.\n\n~~~\n{\n  \"message\": \"There was a server error while excuting this request. Please see system logs for details.\"\n}\n~~~\n\n### Other Errors\n\nAdditional error responses may be received when incorrectly accessing valid API endpoints. The\nerrors received, and their resolution, are specific to the requested URI and HTTP Method and details\nare provided with each endpoint's reference where applicable.\n"}},"baseSlug":"/openapi","routesMapping":{}}