| All Verbs | /GroupAirTravel |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Account | query | string | No | Comma Delimited List of Accounts |
| DateStart | query | string | Yes | Date in format YYYYMMDD |
| DateEnd | query | string | Yes | Date in format YYYYMMDD |
| FromAirportCode | query | string | No | From Airport Code |
| ToAirportCode | query | string | No | To Airport Code |
| RepeatByPassenger | query | boolean | No | Option to place passenger names on separate lines in the downloadable result (spreadsheet) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwningCompanyCode | query | string | No | Comma Delimited List of Owning Company Codes |
| UserName | query | string | No | UserName in form of an email address |
| 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<ApiRequestPerHour> | 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 |
|---|---|---|---|---|
| RequestDate | form | DateTime | No | |
| Hour0 | form | int | No | |
| Hour1 | form | int | No | |
| Hour2 | form | int | No | |
| Hour3 | form | int | No | |
| Hour4 | form | int | No | |
| Hour5 | form | int | No | |
| Hour6 | form | int | No | |
| Hour7 | form | int | No | |
| Hour8 | form | int | No | |
| Hour9 | form | int | No | |
| Hour10 | form | int | No | |
| Hour11 | form | int | No | |
| Hour12 | form | int | No | |
| Hour13 | form | int | No | |
| Hour14 | form | int | No | |
| Hour15 | form | int | No | |
| Hour16 | form | int | No | |
| Hour17 | form | int | No | |
| Hour18 | form | int | No | |
| Hour19 | form | int | No | |
| Hour20 | form | int | No | |
| Hour21 | form | int | No | |
| Hour22 | form | int | No | |
| Hour23 | form | int | 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 |
|---|---|---|---|---|
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime? | No | |
| DepartureDate | form | DateTime? | No | |
| BoardPoint | form | string | No | |
| OffPoint | form | string | No | |
| PnrTicketed | form | string | No | |
| Account | form | string | No | |
| PaxList | form | string | No | |
| Connections | form | string | No | |
| CarrierCode | form | string | No | |
| FlightNumber | form | string | No | |
| TicketNumbers | form | string[] | No | |
| VendorLocators | form | BookingExtVendorLocator[] | No | |
| PassengerInfo | form | BookingPassengerModel[] | No | |
| DepartureDateTime | form | DateTime? | No | |
| CurrentArrivalDateTime | form | DateTime? | No | |
| AgentivityRef | form | int | No | |
| CustomFields | form | CustomFieldsCollection | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CarrierCode | form | string | No | |
| VendorLocator | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FirstName | form | string | No | |
| LastName | form | string | No | |
| PassengerDataId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldName | form | string | No | |
| FieldValue | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GroupAirTravel HTTP/1.1
Host: api.agentivity.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Account":["String"],"DateStart":"String","DateEnd":"String","FromAirportCode":"String","ToAirportCode":"String","RepeatByPassenger":false,"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: application/json
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":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","PaxList":"String","Connections":"String","CarrierCode":"String","FlightNumber":"String","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}],"PassengerInfo":[{"FirstName":"String","LastName":"String","PassengerDataId":0,"Tickets":[{"Number":"String","Type":"String"}]}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}