GET | /TravelHistorySummary/Traveller |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PNRTicketed | query | string | No | Return only PNRs that are ticketed/all |
TravellerReference | query | integer | No | Traveller CRM ID or reference |
TravellerGUID | query | string | No | Agentivity Traveller GUID |
TravellerEmail | query | string | No | An email of a traveller |
TravellerPhoneNbr | query | string | No | Traveller phone number |
TravelDateStart | query | string | No | Date in format YYYYMMDD |
TravelDateEnd | query | string | No | Date in format YYYYMMDD |
CRM | query | string | No | CRM System Name used by Agency |
RequestConsultantID | query | string | No | Request Consultant ID (sign on) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OwningCompanyCode | query | string | No | Comma Delimited List of Owning Company Codes |
UserName | query | string | No | UserName in form of an email address |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | query | string | No | Starting Record |
Limit | query | string | No | Number of records to return (PageSize) |
TotalRecords | query | string | No | Total Number of Records in a Full Reponse (if no paging) |
ResponseRecords | query | string | No | Total Number of Records in this Reponse (on this page) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseMetadata | form | ResponseMetadata | No | |
ResponseReport | form | List<TItem> | No | |
ResponseError | form | AgentivityError | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
HasCache | form | bool | No | |
HasPaging | form | bool | No | |
CacheMetadata | form | CacheMetadata | No | |
PagingMetadata | form | PagingMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CachedAt | form | DateTime | No | |
CacheExpiresAt | form | DateTime | No | |
IsFromCache | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorCode | form | string | No | |
Message | form | string | No | |
StatusCode | form | string | No | |
VerboseMessage | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AverageItineraryChanges | form | float | No | |
BookingsMade | form | int | No | |
CountriesVisited | form | string | No | |
TripClasses | form | string | No | |
BookingsCancelled | form | int | No | |
AirSuppliersUsed | form | string | No | |
Ticketed | form | int | No | |
HotelChainsUsed | form | string | No | |
AdvancePurchaseAverageDays | form | int | No | |
CarSuppliersUsed | form | string | No | |
TopAirSupplierSupport | form | string | No | |
TopDepartureAirports | form | string | No |
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
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: 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":[{"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"}}