v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

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}

---

Get wave times

GET

/api/v2/events/{eventId}/wave-times

Returns a list of wave times for an event

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

Responses

Wave time list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/events/{eventId}/wave-times

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

Samples

---

Create a new wave time

POST

/api/v2/events/{eventId}/wave-times

Create wave time

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Created wave time object

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/events/{eventId}/wave-times

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

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

---

Delete a wave time

DELETE

/api/v2/events/{eventId}/wave-times/{id}

Delete a wave time

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

id*

Wave Time Id

Type

integer

Required

Format

"int64"

Responses

Wave time deleted successfully

DELETE

/api/v2/events/{eventId}/wave-times/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Samples

---

Update a wave time

PATCH

/api/v2/events/{eventId}/wave-times/{id}

Update an existing wave time

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

eventId*

Event Id

Type

integer

Required

Format

"int64"

id*

Wave Time Id

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Updated wave time object

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/events/{eventId}/wave-times/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

Body

Samples

---

Powered by VitePress OpenAPI