Agentivity API

<back to all web services

GetTravelHistorySummaryByTraveller

The following routes are available for this service:
GET/TravelHistorySummary/Traveller
GetTravelHistorySummaryByTraveller Parameters:
NameParameterData TypeRequiredDescription
PNRTicketedquerystringNoReturn only PNRs that are ticketed/all
TravellerReferencequeryintegerNoTraveller CRM ID or reference
TravellerGUIDquerystringNoAgentivity Traveller GUID
TravellerEmailquerystringNoAn email of a traveller
TravellerPhoneNbrquerystringNoTraveller phone number
TravelDateStartquerystringNoDate in format YYYYMMDD
TravelDateEndquerystringNoDate in format YYYYMMDD
CRMquerystringNoCRM System Name used by Agency
RequestConsultantIDquerystringNoRequest Consultant ID (sign on)
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
TravelHistorySummaryV3 Parameters:
NameParameterData TypeRequiredDescription
AverageItineraryChangesformfloatNo
BookingsMadeformintNo
CountriesVisitedformstringNo
TripClassesformstringNo
BookingsCancelledformintNo
AirSuppliersUsedformstringNo
TicketedformintNo
HotelChainsUsedformstringNo
AdvancePurchaseAverageDaysformintNo
CarSuppliersUsedformstringNo
TopAirSupplierSupportformstringNo
TopDepartureAirportsformstringNo

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 //TravelHistorySummary/Traveller HTTP/1.1 
Host: api.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":[{"AverageItineraryChanges":0,"BookingsMade":0,"CountriesVisited":"String","TripClasses":"String","BookingsCancelled":0,"AirSuppliersUsed":"String","Ticketed":0,"HotelChainsUsed":"String","AdvancePurchaseAverageDays":0,"CarSuppliersUsed":"String","TopAirSupplierSupport":"String","TopDepartureAirports":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}