FIND Cancellations

post

https://api.timeedit.net/v1/cancellations/find

Returns the cancellations

Body Params

idFormat

string

enum

Defaults to INTERNAL if not set.

Setting idFormat to EXTERNAL changes the behaviour of the request and response. For the request the id parameter must be a string external id when referencing:

object
field
type
reservationMode

For the response the above list of items (if present) will be referenced by external id instead of internal.

Values that change from integer to string when changing idFormat are shown as either integer or string in the documentation. This is true both for the request and the response.

Allowed:

sort

string

enum

page

int64

limit

int64

modified

object

date

object

searchObjects

array of objects

searchObjects

reservationMode

reservationStatus

array of strings

reservationStatus

mineOnly

boolean

ids

array of int64s

List of cancellation ids to get, these are always returned in the response even if they do not match other query parameters

ids

extIds

array of strings

List of cancellation extIds to get, these are always returned in the response even if they do not match other query parameters

extIds

Responses

200Successful operation

400Bad request

403Forbidden

404Not found