Agentivity API

<back to all web services

GetGroupAirTravel

The following routes are available for this service:
All Verbs/GroupAirTravel
GetGroupAirTravel Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
FromAirportCodequerystringNoFrom Airport Code
ToAirportCodequerystringNoTo Airport Code
RepeatByPassengerquerybooleanNoOption to place passenger names on separate lines in the downloadable result (spreadsheet)
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<ApiRequestPerHour>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
ApiRequestPerHour Parameters:
NameParameterData TypeRequiredDescription
RequestDateformDateTimeNo
Hour0formintNo
Hour1formintNo
Hour2formintNo
Hour3formintNo
Hour4formintNo
Hour5formintNo
Hour6formintNo
Hour7formintNo
Hour8formintNo
Hour9formintNo
Hour10formintNo
Hour11formintNo
Hour12formintNo
Hour13formintNo
Hour14formintNo
Hour15formintNo
Hour16formintNo
Hour17formintNo
Hour18formintNo
Hour19formintNo
Hour20formintNo
Hour21formintNo
Hour22formintNo
Hour23formintNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
GroupAirTravelItem Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
DepartureDateformDateTime?No
BoardPointformstringNo
OffPointformstringNo
PnrTicketedformstringNo
AccountformstringNo
PaxListformstringNo
ConnectionsformstringNo
CarrierCodeformstringNo
FlightNumberformstringNo
TicketNumbersformstring[]No
VendorLocatorsformBookingExtVendorLocator[]No
PassengerInfoformBookingPassengerModel[]No
DepartureDateTimeformDateTime?No
CurrentArrivalDateTimeformDateTime?No
AgentivityRefformintNo
CustomFieldsformCustomFieldsCollectionNo
BookingExtVendorLocator Parameters:
NameParameterData TypeRequiredDescription
CarrierCodeformstringNo
VendorLocatorformstringNo
BookingPassengerModel Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
PassengerDataIdformintNo
CustomFieldData Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
FieldValueformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}