GET api/clients/{clientId}/passengertypes
Gets the list of different types of passengers that may be part of the client's trips. However, this list will account for any passenger types that the client has been denied from bringing. Clients are always denied from bringing other clients.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
ID of the client to get valid passenger types for. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the list of passenger types (code, name, and default space type)
Collection of PassengerTypeName | Description | Type | Additional information |
---|---|---|---|
Code |
Gets or sets the code that can be used to identify the passenger type. |
string |
None. |
Name |
Gets or sets the friendly name of the passenger type. |
string |
None. |
DefaultSpaceType |
Gets or sets the code of the default Space Type that should be selected by default if this passenger type is chosen. |
string |
None. |
FareTypeId |
Gets or sets the fare type Id of the passenger type |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "code": "sample string 1", "name": "sample string 2", "defaultSpaceType": "sample string 3", "fareTypeId": 4 }, { "code": "sample string 1", "name": "sample string 2", "defaultSpaceType": "sample string 3", "fareTypeId": 4 } ]
application/xml, text/xml
Sample:
<ArrayOfPassengerType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <PassengerType> <Code>sample string 1</Code> <DefaultSpaceType>sample string 3</DefaultSpaceType> <FareTypeId>4</FareTypeId> <Name>sample string 2</Name> </PassengerType> <PassengerType> <Code>sample string 1</Code> <DefaultSpaceType>sample string 3</DefaultSpaceType> <FareTypeId>4</FareTypeId> <Name>sample string 2</Name> </PassengerType> </ArrayOfPassengerType>