Agentivity API

<back to all web services

GetBookingsTravellingV2

The following routes are available for this service:
GET/BookingsTravellingV2
GetBookingsTravellingV2 Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
TravelDateStartquerystringYesDate in format YYYYMMDD
TravelDateEndquerystringNoDate in format YYYYMMDD
HasMobilequerybooleanNoReturn only PNRs with/without a mobile number
HasEmailquerybooleanNoReturn only PNRs with/without an email address
MissingEmailOrPhonequerybooleanNoReturn only PNRs with/without an email address OR a mobile number
HasHotelquerybooleanNoReturn only PNRs with/without a hotel
HasAccountquerybooleanNoReturn only PNRs with/without an account
IncludeItineraryquerybooleanNoInclude Itinerary in the response
IncludeParkingOfferquerybooleanNoInclude Parking Offer in the response
MinSegmentsqueryintegerNoReturn only PNRs that equal or exceed a certain number of segments
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)
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
BookingTravellingV2 Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
OwningAgencyLocationIDformstringNo
PNRCreationDateformDateTime?No
PassengersformstringNo
OwningConsultantformstringNo
AccountformstringNo
TravelDateformDateTime?No
MobileformstringNo
EmailsformstringNo
PNRTicketedformstringNo
DestinationCountformintNo
CTCMformstringNo
CTCEformstringNo
AgentivityRefformintNo
ParkingOfferIDformstringNo
ParkingOfferTotalPriceformdecimalNo
ParkingOfferArrivalDateTimeformDateTimeNo
ParkingOfferDepartureDateTimeformDateTimeNo
ParkingOfferAirportCodeformstringNo
ItineraryFormattedformstringNo

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 //BookingsTravellingV2 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":[{"AgentivityRef":0,"RecordLocator":"String","OwningAgencyLocationID":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","OwningConsultant":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Mobile":"String","Emails":"String","PNRTicketed":"String","CTCM":"String","DestinationCount":0,"CTCE":"String","ParkingOfferID":"String","ParkingOfferTotalPrice":0,"ParkingOfferArrivalDateTime":"\/Date(-62135596800000-0000)\/","ParkingOfferDepartureDateTime":"\/Date(-62135596800000-0000)\/","ParkingOfferAirportCode":"String","ItineraryFormatted":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}