Delete Webcam Booking

This API operation lets you delete the received webcambooking for the authenticated user.

URL / Endpoint

POST /v1/Webcam/DeleteReceivedBookings

Request

Property	Type	Description
`BookingIDs`	string	Required. A comma delimited string of IDs of the webcam bookings.

Prerequisites

This endpoint has a prerequisite which affect the current WebcamBooking.

Property	Type	Description
`Status`	string	The Status must be either `Rejected`, `Confirmed` or `Cancelled`.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`account_webcam_bookings`

Samples

POST method

https://api-sandbox.adultwork.com/v1/Webcam/DeleteReceivedBookings

Authorization: bearer {your-access-token}
{
    "BookingIDs" : "1,2"
}

Response

Property	Type	Description
`BookingID`	integer	The ID of the webcambooking.
`Deleted`	boolean	Indicates if the bookings has been deleted.
`Message`	string	The message of the delete action. Possible values are: The session booking cannot be deleted until it has been marked as complete. The status has to be Rejected, Confirmed or cancelled. The session booking cannot be deleted until it has been marked as complete. The status has to be Rejected, Confirmed or cancelled. The booking must have past the 'Accept By' date or be rejected before it can be deleted. The session booking cannot be deleted until it has been marked as complete. The status has to be Rejected, Confirmed or cancelled. The booking has been accepted and cannot be deleted until it is rejected or confirmed and the session date has past. The session booking cannot be deleted until it has been marked as complete. The status has to be Rejected, Confirmed or cancelled. The booking has been confirmed and cannot be deleted unless the user cancels it or until the scheduled session date/time has past. The booking does not exist or does not belong to the user. Booking deleted

Response Sample

The following example shows the data returned from the sample above.

JSON
XML

[
    {
        "BookingID": 1,
        "Deleted":": true,
        "Message":": "Booking deleted"
    },
    {
        "BookingID": 2,
        "Deleted": false,
        "Message": "The booking does not exist or does not belong to the user."
    }
]

<ArrayOfWebcamBookingsDeleteOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Webcam.Delete">
    <WebcamBookingsDeleteOutput>
        <BookingID>1</BookingID>
        <Deleted>true</Deleted>
        <Message>Booking deleted</Message>
    </WebcamBookingsDeleteOutput>
    <WebcamBookingsDeleteOutput>
        <BookingID>2</BookingID>
        <Deleted>false</Deleted>
        <Message>The booking does not exist or does not belong to the user.</Message>
    </WebcamBookingsDeleteOutput>
</ArrayOfWebcamBookingsDeleteOutput>