v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

---

Wave Times

Endpoints to interact with wave times

Operations

GET/api/v2/wave-timePOST/api/v2/wave-timeGET/api/v2/wave-time/{waveTimeId}GET/api/v2/wave-time/event/{eventId}GET/api/v2/wave-time/ticket-type/{typeId}DELETE/api/v2/wave-time/{id}PATCH/api/v2/wave-time/{id}

---

Returns a list of wave times.

GET

/api/v2/wave-time

Returns a list of wave times.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

eventId

The event to return wave times for. Multiple events can included separated by a comma.

Type

string

typeId

The ticket type to return wave times for. Multiple events can included separated by a comma.

Type

string

search

Filter by the wave time description. Uses wild card searches.

Type

string

_include

Adds additional details to the results. Supports the following values: types - Include ticket type ids.

Type

string

_limit

Set the max number of objects to return.

Type

integer

Format

"int64"

_offset

Set the number of objects to ignore before starting.

Type

integer

Format

"int64"

Responses

GET

/api/v2/wave-time

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId

typeId

search

_include

_limit

_offset

Samples

---

Adds a new wave time.

POST

/api/v2/wave-time

Creates a new wave time for an event.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

result

Determines the format of response. If not provided the default is id. Can be one of the following values: none - no body is returned; id - The id of the wave time is returned; object - The entire object is returned.

Type

string

Request Body

application/json

{

  

"eventId": 0,

  

"description": "string",

  

"ordering": 0,

  

"startTimestamp": 0,

  

"quantity": 0,

  

"instructions": "string",

  

"allowSalesMinutesPastStartTime": 0,

  

"types": [

  

  

0

  

]

}

Responses

Information concerning the created wave time.

Content-Type

application/json

"string"

POST

/api/v2/wave-time

Playground

Authorization

bearerAuth

Variables

Key

Value

result

Body

Samples

---

Returns the given wave time.

GET

/api/v2/wave-time/{waveTimeId}

Returns the given wave time.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

waveTimeId*

Id of wave time to return

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/wave-time/{waveTimeId}

Playground

Authorization

bearerAuth

Variables

Key

Value

waveTimeId*

Samples

---

Returns the given wave times for the given event.

GET

/api/v2/wave-time/event/{eventId}

Returns the given wave time for the given event.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Id of event to find wave times for

Type

integer

Required

Format

"int64"

Query Parameters

_include

Adds additional details to the results. Supports the following values: types - Include ticket type ids.

Type

string

Responses

GET

/api/v2/wave-time/event/{eventId}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

_include

Samples

---

Returns the given wave times for the given ticket type.

GET

/api/v2/wave-time/ticket-type/{typeId}

Returns the given wave time for the given ticket type.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

typeId*

Id of ticket type to find wave times for

Type

integer

Required

Format

"int64"

Query Parameters

_include

Adds additional details to the results. Supports the following values: types - Include ticket type ids.

Type

string

Responses

GET

/api/v2/wave-time/ticket-type/{typeId}

Playground

Authorization

bearerAuth

Variables

Key

Value

typeId*

_include

Samples

---

Deletes the given wave time.

DELETE

/api/v2/wave-time/{id}

Deletes the given wave time.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of wave time to delete.

Type

integer

Required

Format

"int64"

Query Parameters

result

Determines the format of response. If not provided the default is id. Can be one of the following values: none - no body is returned; id - The id of the wave time is returned; object - The entire object is returned.

Type

string

Responses

Information concerning the deleted wave time.

Content-Type

application/json

"string"

DELETE

/api/v2/wave-time/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

result

Samples

---

Updates an existing wave time.

PATCH

/api/v2/wave-time/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Id of wave time to update.

Type

integer

Required

Format

"int64"

Query Parameters

result

Determines the format of response. If not provided the default is id. Can be one of the following values: none - no body is returned; id - The id of the wave time is returned; object - The entire object is returned.

Type

string

Request Body

application/json

{

  

"description": "string",

  

"ordering": 0,

  

"startTimestamp": 0,

  

"quantity": 0,

  

"instructions": "string",

  

"allowSalesMinutesPastStartTime": 0,

  

"types": [

  

  

0

  

]

}

Responses

Information concerning the updated wave time.

Content-Type

application/json

"string"

PATCH

/api/v2/wave-time/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

result

Body

Samples

---

Powered by VitePress OpenAPI