Agentivity API

<back to all web services

GetPassengerArrivals

The following routes are available for this service:
GET/PassengerArrivals
GetPassengerArrivals Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
UserNamequerystringYesUserName in form of an email address
ArrivalDateStartquerystringYesDate in format YYYYMMDD
ArrivalDateEndquerystringNoDate in format YYYYMMDD
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)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
PassengerArrival Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
OwningAgencyLocationIDformstringNo
OwningConsultantformstringNo
OwningConsultantIDformstringNo
PassengerformstringNo
AccountformstringNo
TravelDateformDateTime?No
ArrivalDateformDateTime?No
DaysAwayformint?No
DestinationCountriesformstringNo
MobileListformstringNo
EmailListformstringNo
CabinsNamesformstringNo
PNRTicketedDateformDateTime?No
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //PassengerArrivals HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
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":{"Item":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","ArrivalDate":"\/Date(-62135596800000-0000)\/","DaysAway":0,"DestinationCountries":"String","MobileList":"String","EmailList":"String","CabinsNames":"String","PNRTicketedDate":"\/Date(-62135596800000-0000)\/"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}