Call

/v0.1/CancelScheduledPlay/

Cancels a scheduled playback request

post/v0.1/CancelScheduledPlay/

Request

Base URL
https://eqivo.org (the document declares no server; this is the origin it was published from)
Auth
HTTP basic
TypeScript
https://skmtc.dev/eqivo/apis/eqivo-api/docs/v0.1/CancelScheduledPlay/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

SchedPlayIdstring required

Unique identifier returned when scheduled playback was originally requested

Example request

{
  "SchedPlayId": "ea428fbd-ac9b-498c-8bb2-a36ac49f10fd"
}

Response

Message'Scheduled Play Cancelation Executed' | 'SchedPlayId Parameter must be present' | 'Scheduled Play Cancelation Failed -- ID not found' | 'Scheduled Play Cancelation Failed' required

Response message

Successboolean required

Whether the request was successful or not

Example response

{
  "Message": "Scheduled Play Cancelation Executed",
  "Success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.