| GET | /TravellerGroupAirSegments |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserName | query | string | Yes | UserName in form of an email address |
| Account | query | string | No | Comma Delimited List of Accounts |
| Group | query | integer | No | ID of a group |
| DepartureDateStart | query | string | Yes | Date in format YYYYMMDD |
| DepartureDateEnd | query | string | Yes | Date in format YYYYMMDD |
| MaxTravellerIsExceededFlag | query | string | No | Filter the report to only show cases where the max value is exceeded |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | query | string | No | Starting Record |
| Limit | query | string | No | Number of records to return (PageSize) |
| TotalRecords | query | string | No | Total Number of Records in a Full Reponse (if no paging) |
| ResponseRecords | query | string | No | Total Number of Records in this Reponse (on this page) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseMetadata | form | ResponseMetadata | No | |
| ResponseReport | form | List<TItem> | No | |
| ResponseError | form | AgentivityError | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| HasCache | form | bool | No | |
| HasPaging | form | bool | No | |
| CacheMetadata | form | CacheMetadata | No | |
| PagingMetadata | form | PagingMetadata | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CachedAt | form | DateTime | No | |
| CacheExpiresAt | form | DateTime | No | |
| IsFromCache | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| StatusCode | form | string | No | |
| VerboseMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Passenger | form | string | No | |
| FlightNbr | form | string | No | |
| OperatingCarrierCode | form | string | No | |
| DepartureCity | form | string | No | |
| DepartureDate | form | string | No | |
| DepartureTime | form | string | No | |
| ArrivalCity | form | string | No | |
| ArrivalDate | form | string | No | |
| ArrivalTime | form | string | No | |
| RecordLocator | form | string | No | |
| PNRTicketed | form | string | No | |
| Account | form | string | No | |
| GroupName | form | string | No | |
| GroupInfo | form | string | No | |
| TravellerCount | form | int? | No | |
| MaxTravellerCount | form | int? | No | |
| MaxTravellerCountExceededFlag | form | bool | No | |
| CostCentre | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET //TravellerGroupAirSegments HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"Passenger":"String","FlightNbr":"String","OperatingCarrierCode":"String","DepartureCity":"String","DepartureDate":"String","DepartureTime":"String","ArrivalCity":"String","ArrivalDate":"String","ArrivalTime":"String","RecordLocator":"String","PNRTicketed":"String","Account":"String","GroupName":"String","GroupInfo":"String","TravellerCount":0,"MaxTravellerCount":0,"MaxTravellerCountExceededFlag":false,"CostCentre":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}