v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

WaveTimes

Endpoints to interact with wave times

Operations

GET/api/v2/events/{eventId}/wave-timesPOST/api/v2/events/{eventId}/wave-timesGET/api/v2/events/{eventId}/wave-times/{id}DELETE/api/v2/events/{eventId}/wave-times/{id}PATCH/api/v2/events/{eventId}/wave-times/{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

---

Get wave time by ID

GET

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

Returns a single 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 object

Content-Type

application/json

{

  

"data": "string"

}

GET

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

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId*

id*

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