This API operation retrieves a single Escort Booking made by the user.
GET
/v1/Bookings/GetMadeBooking
GET
/v1/Groups/Bookings/GetMadeBooking
(See Group manager)
Property | Type | Description |
---|---|---|
BookingID |
string | Required. The ID of the escort booking. |
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. |
Parameters can be passed to this operation using the HTTP GET method by passing parameters over the query string of the URI.
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.
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.
This endpoint requires the following scope:
Scope |
---|
account_escort_bookings |
Property | Type | Description |
---|---|---|
BookingID |
integer | Represents the ID of the booking. |
Date |
datetime | Represents the date and time of the booking. |
MeetStartDate |
datetime | Represents the start date and time of the booking. |
MeetEndDate |
datetime | Represents the end date and time of the booking. |
DateRead |
datetime | Represents the date of when the booked user has read the booking. |
Comments |
string | Represents the provided comments. |
IsInCall |
boolean | Represents if the booking is requested as an In-Call. |
IsOutCall |
boolean | Represents if the booking is requested as an Out-Call. |
Price |
decimal | Represents the price. |
Currency |
string | Represents the currency the user will be paid in. |
Location |
string | Represents the location. |
IsScheduled |
string | Represents if the booking is scheduled. |
IsConfirmed |
string | Represents if the booking is confirmed. |
IsRead |
string | Represents if the booking is read. |
User |
aws:BookedEscortUser | Represents the user who received the booking. |
The following example returns a page of 10 Escort Bookings.