Get Bookings

Use this method to get an AdultWork.com user's bookings.

URL / Endpoint

GET /v1/Bookings/GetBookings

GET /v1/Groups/Bookings/GetBookings (See Group manager)

Request

Property	Type	Description
`BookingsPerPage`	integer	Sets the number of bookings on each page of the result set. Accepts values from `1` to `100`. Default is `50`.
`PageNumber`	integer	Returns a specific page in the result set. Accepts values from `1` onwards.
`OrderBy`	string	Sets the order in which the bookings will be returned. If set to Default is date-asc. Order options are `date-asc`, `date-desc`, `nickname-asc`, `nickname-desc`, `meetdate-asc` and `meetdate-desc`.
`UnreadOnly`	boolean	If set to `true` only the unread bookings are returned. Default is `false`.

Group manager

If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.

The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. Additionally, it has the following extra parameters:

Property	Type	Description
`UserID`	integer	Required. The ID of a member in the group that will be impersonated for this request.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.

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_escort_bookings`

Samples

GET method

GET https://api-sandbox.adultwork.com/v1/Bookings/GetBookings

Authorization: bearer {your-access-token}

GET as Group manager

GET https://api-sandbox.adultwork.com/v1/Groups/Bookings/GetBookings
?UserID=123456

Authorization: bearer {your-access-token}

Response

Property	Type	Description
`PageCount`	integer	Represents the total number of pages in the result set.
`PageNumber`	integer	Represents the current page number.
`BookingsTotal`	integer	Represents the total number of bookings in the result set.
`BookingsPerPage`	integer	Represents how many bookings are listed on each page.
`Bookings`	Array of aws:Booking	List of booking data.

Response Sample

The following example shows the AdultWork.com result for the request.

JSON
XML

{
  "PageCount": 1,
  "PageNumber": 1,
  "BookingsTotal": 1,
  "BookingsPerPage": 20,
  "Bookings": [
    {
      "BookingID": 1,
      "Date": "2016-01-01T20:15:09.607",
      "MeetStartDate": "2016-02-02T13:00:00",
      "MeetEndDate": "2016-02-02T15:00:00",
      "ContactOnStartDate": "2016-01-20T09:00:00",
      "ContactOnEndDate": "2016-01-20T10:30:00",
      "ContactNumber": "123456789",
      "Comments": null,
      "IsInCall": true,
      "IsOutCall": false,
      "Price": 200,
      "Currency": "GBP",
      "Location": "In-Call",
      "IsScheduled": false,
      "IsConfirmed": true,
      "IsRead": true,
      "User": {
        "UserID": 123456,
        "Nickname": "JosepheneBlogs",
        "FirstName": "Josephene",
        "LastName": "Blogs",
        "GenderID": 2,
        "HasAlias": false,
        "AliasHasNegativeRating": false,
        "ClientNote": "Neutral",
        "Ratings": {
            "Total":33,
            "Positive":34,
            "Neutral":0,
            "Negative":1,
            "Ratings":35,
            "Disputes":0        
             }
      }
    }]
}

<PageCount>1</PageCount>
<PageNumber>1</PageNumber>
<BookingsTotal>1</PageNumber>
<BookingsPerPage>20</BookingsPerPage>
<Bookings>
    <Booking>
      <BookingID>1</BookingID>
      <Date>2016-01-01T20:15:09.607</Date>
      <MeetStartDate>2016-02-02T13:00:00</MeetStartDate>
      <MeetEndDate>2016-02-02T15:00:00</MeetEndDate>	
      <ContactOnStartDate>2016-01-02T09:00:00</ContactOnStartDate>
      <ContactOnEndDate>2016-01-02T10:30:00</ContactOnEndDate>
      <ContactNumber>123456789</ContactNumber>
      <Comments>NULL</Comments>
      <InCall>true</InCall>
      <OutCall>false</OutCall>
      <Price>200</Price>
      <Currency>GBP</Currency>
      <Location>In-Call</Location>
      <IsScheduled>false</IsScheduled>
      <IsConfirmed>true</IsConfirmed>
      <IsRead>true</IsRead>
      <User>
          <UserID>123456</UserID>
	  <Nickname>JosepheneBlogs</Nickname>
	  <FirstName>Josephene</FirstName>
	  <LastName>Blogs</LastName>
	  <GenderID>2</LastName>
	  <HasAlias>false</HasAlias>
	  <AliasHasNegativeRating>false</AliasHasNegativeRating>
	  <ClientNote>Neutral</ClientNote>
	  <Ratings>
	      <Disputes>0</Disputes>
	      <Negative>1</Negative>
              <Neutral>0</Neutral>
	      <Positive>34</Positive>
	      <Ratings>29</Ratings>
	      <Total>33</Total>
	  </Ratings>
       </User>
    </Booking>
</Bookings>