Agentivity API

<back to all web services

GetPassengerDepartures

The following routes are available for this service:
GET/PassengerDepartures
GetPassengerDepartures Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
ClassNamequerystringNoName of the class
CarrierquerystringNoCarrier name
TravelDateStartquerystringYesDate in format YYYYMMDD
TravelDateEndquerystringNoDate in format YYYYMMDD
WithSMSquerybooleanNoInclude items with SMS sent in response
AddVouchersquerybooleanNoAdd transfers
AddTransfersquerybooleanNoAdd transfers
IncludeItineraryquerybooleanNoInclude Itinerary in the response
IsVipquerybooleanNoReturn only PNRs that are or are not flagged as VIP bookings
ShowSMSquerybooleanNoShow SMS
ItineraryFormattingqueryintegerNoIndicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
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)
FormattingStyle Enum:
NameValue
None0
Html1
Charting2
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
PassengerDeparture Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
RecordLocatorformstringNo
OwningAgencyLocationIDformstringNo
OwningConsultantformstringNo
OwningConsultantIDformstringNo
GdsCodeformstringNo
PassengerformstringNo
AccountformstringNo
TravelDateformDateTime?No
TicketedStatusCodeformstringNo
TicketedStatusformstringNo
SupplierReferenceformstringNo
SMSformstringNo
VouchersformstringNo
TransfersformstringNo
IsVipformboolNo
PhoneNbrformstringNo
EmailAddressformstringNo
DestinationCitiesformstringNo
DestinationCountriesformstringNo
ConnectionsformstringNo
ItineraryformItinerarySegmentsCollectionNo
ItineraryFormattedformstringNo
ItinerarySegment Parameters:
NameParameterData TypeRequiredDescription
SegmentTypeformstringNo
SegmentNbrformintNo
BoardPointformstringNo
OffPointformstringNo
OperatorCodeformstringNo
OperatorServiceformstringNo
SegmentStatusformstringNo
DepartureTimeFormattedformstringNo
ArrivalTimeFormattedformstringNo
ChangeOfDayFormattedformstringNo
ServiceCodeformstringNo
StartDateformstringNo
EndDateformstringNo
TicketNumberformstringNo
VendorLocatorsquerystringNoComma separated list of vendor locators
EquipmentCodeformstringNo
EquipmentformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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

HTTP + CSV

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

GET /PassengerDepartures HTTP/1.1 
Host: servicestack.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":{"Item":{"AgentivityRef":0,"RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","TicketedStatusCode":"String","TicketedStatus":"String","SupplierReference":"String","SMS":"String","Vouchers":"String","Transfers":"String","IsVip":false,"PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","DestinationCountries":"String","Connections":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}