Agentivity API

<back to all web services

GetPassengerLocationsByCity

The following routes are available for this service:
GET/PassengerLocationsByCity
GetPassengerLocationsByCity Parameters:
NameParameterData TypeRequiredDescription
CityCodequerystringYes3 letter city code
DateEndquerystringYesDate in format YYYYMMDD
DateStartquerystringYesDate in format YYYYMMDD
InTransitOnlyquerystringNoInclude passengers that are in transit only in response
AccountquerystringNoComma Delimited List of Accounts
WithHotelquerybooleanNoInclude items with hotel in response
HotelNamequerystringNoName of the hotel
CustomFieldquerystringNoComma Delimited List of Custom Fields
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<TItem>No
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
PassengerLocation Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
TravelDateformDateTime?No
DepartureDateformDateTime?No
BoardPointformstringNo
OffPointformstringNo
PnrTicketedformstringNo
AccountformstringNo
ConsultantformstringNo
PaxListformstringNo
PhoneNbrformstringNo
EmailAddressformstringNo
DestinationCitiesformstringNo
ConnectionsformstringNo
CarrierCodesformstringNo
HotelsNamesformstringNo
FlightNumbersformstringNo
OwningAgencyLocationIDformstringNo
IataCodesformstringNo
AgentivityRefformintNo
ItineraryformItinerarySegmentsCollectionNo
ItineraryFormattedformstringNo
CustomFieldsformCustomFieldsCollectionNo
DepartureDateTimeformDateTime?No
CurrentArrivalDateTimeformDateTime?No
SegmentTypeformstringNo
AirSegmentNbrformstringNo
PNRCreationDateformDateTime?No
TicketNumbersformstring[]No
VendorLocatorsformBookingExtVendorLocator[]No
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
CustomFieldData Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
FieldValueformstringNo
BookingExtVendorLocator Parameters:
NameParameterData TypeRequiredDescription
CarrierCodeformstringNo
VendorLocatorformstringNo

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 //PassengerLocationsByCity 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":[{"RecordLocator":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","Consultant":"String","PaxList":"String","PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","AgentivityRef":0,"HotelsNames":"String","FlightNumbers":"String","OwningAgencyLocationID":"String","IataCodes":"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","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","AirSegmentNbr":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}