Agentivity API

GetTravelHistorySummaryByTraveller

The following routes are available for this service:
GET	/TravelHistorySummary/Traveller

**GetTravelHistorySummaryByTraveller** Parameters:
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)

**CompanyLevelRequestBase** Parameters:
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

**PagingMetadata** Parameters:
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)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<TItem>	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**TravelHistorySummaryV3** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <TravellerHistory>
      <AdvancePurchaseAverageDays>0</AdvancePurchaseAverageDays>
      <AirSuppliersUsed>String</AirSuppliersUsed>
      <AverageItineraryChanges>0</AverageItineraryChanges>
      <BookingsCancelled>0</BookingsCancelled>
      <BookingsMade>0</BookingsMade>
      <CarSuppliersUsed>String</CarSuppliersUsed>
      <CountriesVisited>String</CountriesVisited>
      <HotelChainsUsed>String</HotelChainsUsed>
      <Ticketed>0</Ticketed>
      <TripClasses>String</TripClasses>
      <TopAirSupplierSupport>String</TopAirSupplierSupport>
      <TopDepartureAirports>String</TopDepartureAirports>
    </TravellerHistory>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>