GET api/clients/{clientID}/defaultPassengers
Gets the list of the client's default passengers when booking a new trip.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientID |
The ID of the client. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the list of the client's default passengers.
Collection of ClientDefaultPassenger| Name | Description | Type | Additional information |
|---|---|---|---|
| PassengerTypeCode |
The passenger's type |
string |
None. |
| SpaceTypeCode |
The passenger's space type |
string |
None. |
| Required |
Gets whether the client is required to travel with this passenger, and is unable to remove them |
boolean |
None. |
| IsNotAllowedEscorts |
Gets or sets whether the client is allowed any escorts (Novus Only) |
boolean |
None. |
| FundingProgramIds |
Gets or sets the collection of funding program ids associated with booking per activity. Keeping this this as an array since we may support multiple funding programs in future |
Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"passengerTypeCode": "Escort",
"spaceTypeCode": "AM",
"required": false,
"isNotAllowedEscorts": false,
"fundingProgramIds": null
}
]
application/xml, text/xml
Sample:
<ArrayOfClientDefaultPassenger xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
<ClientDefaultPassenger>
<FundingProgramIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<IsNotAllowedEscorts>false</IsNotAllowedEscorts>
<PassengerTypeCode>Escort</PassengerTypeCode>
<Required>false</Required>
<SpaceTypeCode>AM</SpaceTypeCode>
</ClientDefaultPassenger>
</ArrayOfClientDefaultPassenger>