Cancel Webcam Booking

This API operation lets you cancel the received booking for the authenticated user.

URL / Endpoint

POST /v1/Webcam/CancelReceivedBooking

Request

Property	Type	Description
`BookingID`	integer	Required. The ID of the webcam booking.
`Reason`	string	Required. The reason why the performer has cancelled this booking.

Prerequisites

This endpoint has a couple of prerequisites which affect the current WebcamBooking.

Property	Type	Description
`Status`	string	The Status must be `Accepted`.
`SessionDate`	datetime	The SessionDate cannot be in the past.

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/CancelReceivedBooking

Authorization: bearer {your-access-token}
{
    "BookingID" : 1,
    "Reason" : "I have a photo-shoot at that time, can't make it. Sorry xxx"
}

Response

Property	Type	Description
`WebcamBookingID`	integer	The ID of the webcambooking.
`Duration`	integer	The duration in minutes.
`Credits`	decimal	The amount of credits offered.
`Status`	string	The status of the webcam booking. Possible values are: `Pending` `Accepted` `Rejected` `Confirmed` `Cancelled`.
`IsMulitple`	boolean	Indicates if this bookings has been sent to other users as well.
`SoftwareTypeID`	integer	The type of software the client wants to use. Possible values are: `1` for *MSN Messenger, `2` for Yahoo Messenger* and `3` for *Skype*.
`SignInNameOrEmail`	string	The sign-in name or email address of the performer.
`AlsoPhoneChat`	boolean	Indicates if this booking was requested as a PhoneChat as well.
`CreateDate`	datetime	Represents the date and time of when this booking was made.
`SessionDate`	datetime	Represents the date and time of when this webcam session should take place.
`AcceptBy`	datetime	Represents the date and time before this webcam booking needs to be accepted.
`AcceptedDate`	datetime	Represents the date and time of when this webcam session was accepted.
`ConfirmedDate`	datetime	Represents the date and time of when this webcam session was confirmed.
`CancelledDate`	datetime	Represents the date and time of when this webcam session was cancelled.
`CancelledReason`	string	Represents the reason why this webcam booking was rejected.
`CancelledBy`	string	Represents the Nickname of the user that cancelled this webcam booking.
`RejectedReason`	string	Represents the reason why this webcam booking has been rejected.
`LastUpdated`	datetime	Represents the date and time of when this webcam session was last updated.
`Client`	aws:WebcamBookingClient	Represents the client user who created the booking.

Response Sample

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

JSON
XML

{
    "WebcamBookingID": 1,
    "Duration": 10,
    "Credits": 10,
    "Status": "Cancelled",
    "IsMulitple": true,
    "SoftwareTypeID": 3,
    "SignInNameOrEmail": "PerformingUserOnSkype",
    "AlsoPhoneChat": true,
    "CreateDate": "2018-01-01T11:00",
    "SessionDate": "2018-02-01T12:00",
    "AcceptBy": "2018-02-01T00:00",
    "AcceptedDate": "2018-01-01T15:00",
    "ConfirmedDate": null,
    "CancelledDate": "2018-01-01T16:00",
    "CancelledReason": "I have a photo-shoot at that time, can't make it. Sorry xxx",
    "CancelledBy": "PerformingUser",
    "RejectedReason": null,
    "LastUpdated": "2018-01-01T16:00",
    "Client": {
        "UserID": 123456,
        "Nickname": "JosepheneBlogs",
        "LastAccessedFrom": "UK",
        "SignInNameOrEmail": null,
        "PhoneNumber": null,
        "Total": 6,
        "Positive": 7,
        "Neutral": 1,
        "Negative": 0,
        "Ratings": 8,
        "Disputes": 0
    }
}

<WebcamBooking xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Webcam.Received">
    <AcceptBy>2018-02-01T00:00</AcceptBy>
    <AcceptedDate>2018-01-01T15:00</AcceptedDate>
    <AlsoPhoneChat>true</AlsoPhoneChat>
    <CancelledBy>PerformingUser</CancelledBy>
    <CancelledDate>2018-01-01T16:00</CancelledDate>
    <CancelledReason>I have a photo-shoot at that time, can't make it. Sorry xxx</CancelledReason>
    <Client>
        <Disputes xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">0</Disputes>
        <Negative xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">0</Negative>
        <Neutral xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">1</Neutral>
        <Positive xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">7</Positive>
        <Ratings xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">8</Ratings>
        <Total xmlns="http://schemas.datacontract.org/2004/07/API.Models.Profile">6</Total>
        <LastAccessedFrom>UK</LastAccessedFrom>
        <Nickname>JosepheneBlogs</Nickname>
        <PhoneNumber i:isnil="true" />
        <SignInNameOrEmail i:isnil="true" />
        <UserID>1</UserID>
    </Client>
    <ConfirmedDate i:nil="true" />
    <CreateDate>2018-01-01T11:00</CreateDate>
    <Credits>10.0000</Credits>
    <Duration>10</Duration>
    <IsMulitple>true</IsMulitple>
    <LastUpdated>2018-01-01T16:00</LastUpdated>
    <RejectedReason i:nil="true" />
    <SessionDate>2018-02-01T00:00</SessionDate>
    <SignInNameOrEmail>PerformingUserOnSkype</SignInNameOrEmail>
    <SoftwareTypeID>3</SoftwareTypeID>
    <Status>Rejected</Status>
    <WebcamBookingID>1</WebcamBookingID>
</WebcamBooking>