TickeTing REST API v3 Reference (3.0.0)

Introduction

The TickeTing REST API v3 allows developers to integrate with the TickeTing platform, from creating hosts and events to buying and transferring tickets. This reference document will walk you through authenticating against the API and the full list of available endpoints, their permissions and functionality.

Authentication

The TickeTing API uses API keys to authenticate requests. You must provide a valid API Key in the X-API-Key header of each request you make. There are two ways to get a valid API Key:

  1. Start a session with a valid TickeTing username and password (this gives access based on the user's permissions).

  2. Secure an integration key from a system administrator. Integration keys grant an access level determined by the administrator on creation.

Session Authentication and Integration Keys are covered in the Authentication section of this reference.

Example Request Header

X-API-Key: a9427bf35dd3d3011a1277c9c344ae07

Authentication Errors

Omitting the X-API-Key Header from your request or specifying an empty value, will result in the following 401 error response.

{
  "message": "Your request could not be authenticated."
}

If an invalid X-API-Key value is provided, or the provided key is valid, but does not have permission to access the requested resource, the following 403 error response is sent.

{
  "message": "You are restricted from accessing this resource."
}

Client Version

All requests to the API must advertise the version of the API they wish to integrate with. This ensures compatability with the server. This is done by including the X-Client-Version header in every request along with the expected API version. In this way the server can indicate when a client must upgrade to avoid breaking changes.

Example Request Header

X-Client-Version: 3.0.0

Client Version Errors

If the X-Client-Version header is omitted from your request, or the provided version does not meet the minimum required by the API, the following 412 error response is sent.

{
    "error": "Please upgrade your client to complete this request"
}

Error Responses

404 Errors

Requests to the API can result in a 404 error for two reasons:

  1. The endpoint you are trying to access does not exist, in which case you will see the following response:

    {
    "message": "The requested endpoint /invalid/endpoint does not exist on this server."
}

  2. The endpoint you are requesting exists, but a resource cannot be located using the given URI. For example, trying to access an event resource with a non-existant ID such as /events/0000000 will result in the following response:

    {
    "error": "There is presently no resource with the given URI."
}

Server Errors

This version of the API is still under development and there may be bugs and runtime errors encountered while processing your request. In these cases, a 500 error response will be sent with the message below. If such a message is received, please contact a system administrator with the details of your request (endpoint, method, headers and payload), so they may reproduce and resolve the issue.

{
  "message": "There was a server error while excuting this request. Please see system logs for details."
}

Other Errors

Additional error responses may be received when incorrectly accessing valid API endpoints. The errors received, and their resolution, are specific to the requested URI and HTTP Method and details are provided with each endpoint's reference where applicable.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
TickeTing Inc.

dev@ticketingevents.com

License

Apache 2.0

Languages
Servers
Mock server

https://docs.ticketingevents.com/_mock/openapi/

QA Server

https://qa.ticketingevents.com/v3/

Production Server

https://api.ticketingevents.com/v3/

Session Authentication

Operations

Token Authentication

Operations

API Integrations

Operations

Account Management

Operations

Account Verification

Operations

Account Activation

Operations

Password Reset

Operations

Account Activity

Operations

Managing Host Accounts

Operations

Create an event host

Request

Create a new host which can list events, sell tickets, book advertising, or request add-on services through TickeTing. The authorising user account is automatically added to the event host's list of administrators upon creation.

Bodyapplication/json
namestringrequired

Unique name of the event host

contactstringrequired

First and last name of the event host's primary contact person

emailstring(email)required

Primary contact email address of the event host

descriptionstring

Brief description of the nature of the events put on by the host

phonestring(phone)

Primary contact number of the event host

websitestring(uri)

URL of the event host's website, if one exists

countrystring

The country in which the host's events will be primarily staged

firstAddressLinestring

The first line of the event host's mailing address

secondAddressLinestring

The second line of the event host's mailing address

citystring

The city portion of the event host's mailing address

statestring

The state, parish or district portion of the event host's mailing address

businessNostring

The event host's unique registration number, if it maintains a registered business entity

curl -i -X POST \
  https://docs.ticketingevents.com/_mock/openapi/hosts \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "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",
    "x-parsed-md-description": {
      "result": [
        {
          "$$mdtype": "Node",
          "errors": [],
          "lines": [
            0,
            1
          ],
          "inline": false,
          "attributes": {},
          "children": [
            {
              "$$mdtype": "Node",
              "errors": [],
              "lines": [
                0,
                1
              ],
              "inline": false,
              "attributes": {},
              "children": [
                {
                  "$$mdtype": "Node",
                  "errors": [],
                  "lines": [
                    0,
                    1
                  ],
                  "inline": true,
                  "attributes": {
                    "content": "Premier events for supes of all ages"
                  },
                  "children": [],
                  "type": "text",
                  "annotations": [],
                  "slots": {}
                }
              ],
              "type": "inline",
              "annotations": [],
              "slots": {}
            }
          ],
          "type": "paragraph",
          "annotations": [],
          "slots": {}
        }
      ]
    }
  }'

Responses

The new host was successfully created.

Bodyapplication/json
selfstring(uri)

URI of the host resource

namestring

Unique name of the event host

contactstring

First and last name of the event host's primary contact person

emailstring(email)

Primary contact email address of the event host

descriptionstring

Brief description of the nature of the events put on by the host

phonestring(phone)

Primary contact number of the event host

websitestring(uri)

URL of the event host's website, if one exists

countrystring

The country in which the host's events will be primarily staged

firstAddressLinestring

The first line of the event host's mailing address

secondAddressLinestring

The second line of the event host's mailing address

citystring

The city portion of the event host's mailing address

statestring

The state, parish or district portion of the event host's mailing address

businessNostring

The event host's unique registration number, if it maintains a registered business entity

administratorsstring(uri)

URI of the host's administrative user collection

eventsstring(uri)

URI of the collection of events being staged by this host

Response
application/json
{
  "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",
  "state": "Saint John",
  "businessNo": "A5585291",
  "administrators": "/hosts/16951985851389/administrators",
  "events": "/hosts/16951985851389/events",
  "x-parsed-md-description": {
    "result": [ … ]
  }
}

Retrieve host details

Request

Retrieve the registration details of the specified host.

Path
hostintegerrequired

Unique identifier of the requested host

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Details of the requested event host were successfully retrieved.

Bodyapplication/json
selfstring(uri)

URI of the host resource

namestring

Unique name of the event host

contactstring

First and last name of the event host's primary contact person

emailstring(email)

Primary contact email address of the event host

descriptionstring

Brief description of the nature of the events put on by the host

phonestring(phone)

Primary contact number of the event host

websitestring(uri)

URL of the event host's website, if one exists

countrystring

The country in which the host's events will be primarily staged

firstAddressLinestring

The first line of the event host's mailing address

secondAddressLinestring

The second line of the event host's mailing address

citystring

The city portion of the event host's mailing address

statestring

The state, parish or district portion of the event host's mailing address

businessNostring

The event host's unique registration number, if it maintains a registered business entity

administratorsstring(uri)

URI of the host's administrative user collection

eventsstring(uri)

URI of the collection of events being staged by this host

Response
application/json
{
  "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",
  "state": "Saint John",
  "businessNo": "A5585291",
  "administrators": "/hosts/16951985851389/administrators",
  "events": "/hosts/16951985851389/events",
  "x-parsed-md-description": {
    "result": [ … ]
  }
}

Update host details

Request

Change the registered details of the specified event host

Path
hostintegerrequired

Unique identifier of the requested host

Bodyapplication/json
namestringrequired

Unique name of the event host

contactstringrequired

First and last name of the event host's primary contact person

emailstring(email)required

Primary contact email address of the event host

descriptionstring

Brief description of the nature of the events put on by the host

phonestring(phone)

Primary contact number of the event host

websitestring(uri)

URL of the event host's website, if one exists

countrystring

The country in which the host's events will be primarily staged

firstAddressLinestring

The first line of the event host's mailing address

secondAddressLinestring

The second line of the event host's mailing address

citystring

The city portion of the event host's mailing address

statestring

The state, parish or district portion of the event host's mailing address

businessNostring

The event host's unique registration number, if it maintains a registered business entity

curl -i -X PUT \
  'https://docs.ticketingevents.com/_mock/openapi/hosts/{host}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "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",
    "x-parsed-md-description": {
      "result": [
        {
          "$$mdtype": "Node",
          "errors": [],
          "lines": [
            0,
            1
          ],
          "inline": false,
          "attributes": {},
          "children": [
            {
              "$$mdtype": "Node",
              "errors": [],
              "lines": [
                0,
                1
              ],
              "inline": false,
              "attributes": {},
              "children": [
                {
                  "$$mdtype": "Node",
                  "errors": [],
                  "lines": [
                    0,
                    1
                  ],
                  "inline": true,
                  "attributes": {
                    "content": "Premier events for supes of all ages"
                  },
                  "children": [],
                  "type": "text",
                  "annotations": [],
                  "slots": {}
                }
              ],
              "type": "inline",
              "annotations": [],
              "slots": {}
            }
          ],
          "type": "paragraph",
          "annotations": [],
          "slots": {}
        }
      ]
    }
  }'

Responses

The host details were successfully updated.

Bodyapplication/json
selfstring(uri)

URI of the host resource

namestring

Unique name of the event host

contactstring

First and last name of the event host's primary contact person

emailstring(email)

Primary contact email address of the event host

descriptionstring

Brief description of the nature of the events put on by the host

phonestring(phone)

Primary contact number of the event host

websitestring(uri)

URL of the event host's website, if one exists

countrystring

The country in which the host's events will be primarily staged

firstAddressLinestring

The first line of the event host's mailing address

secondAddressLinestring

The second line of the event host's mailing address

citystring

The city portion of the event host's mailing address

statestring

The state, parish or district portion of the event host's mailing address

businessNostring

The event host's unique registration number, if it maintains a registered business entity

administratorsstring(uri)

URI of the host's administrative user collection

eventsstring(uri)

URI of the collection of events being staged by this host

Response
application/json
{
  "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",
  "state": "Saint John",
  "businessNo": "A5585291",
  "administrators": "/hosts/16951985851389/administrators",
  "events": "/hosts/16951985851389/events",
  "x-parsed-md-description": {
    "result": [ … ]
  }
}

Working with Events

Operations

Event Admissions

Operations

Event Reporting

Operations

Ad Zone Management

Operations

Advertising an Event

Operations

Placing an Order

Operations

Order Settlement

Operations

Ticket Transfers

Operations

Region Management

Operations

Venue Management

Operations

Category Management

Operations

Reviewing Content

Operations

Transaction Reports

Operations

Default Values

Operations