Companionships
Get all companionships
Returns all companionships based on customers, reservations or reservation groups. One of them must be specified in the request. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/companionships/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of Companionship. |
| array of string | optional, max 1000 items | Unique identifiers of Customers. |
| array of string | optional, max 1000 items | Unique identifiers of reservations. |
| array of string | optional, max 1000 items | Unique identifiers of Reservation groups. |
| optional, max length 3 months | Interval in which the Companionship was updated. | |
| required | Extent of data to be returned. E.g. it is possible to specify that together with the companionships, customers, reservations, and reservation groups should be also returned. | |
| required | Limitation on the quantity of data returned. |
Companionship extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | optional | Whether the response should contain customers. |
| bool | optional | Whether the response should contain reservations. |
| bool | optional | Whether the response should contain reservation groups. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Companionship | required | Companionships. |
| array of Customer | optional | Customers that belong to the companionships. |
| array of Reservation | optional | The accompanied reservations. |
| array of Reservation group | optional | The accompanied reservation groups. |
| string | optional | Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. |
Companionship
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of Companionship. |
| string | required | Unique identifier of Customer. |
| string | optional | Unique identifier of reservation. |
| string | required | Unique identifier of Reservation group. |
Last updated