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 .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 //BookingsTravellingV2 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>
    <Booking>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <Passengers>String</Passengers>
      <OwningConsultant>String</OwningConsultant>
      <Account>String</Account>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <Mobile>String</Mobile>
      <Emails>String</Emails>
      <CTCM>String</CTCM>
      <PNRTicketed>String</PNRTicketed>
      <CTCE>String</CTCE>
      <DestinationCount>0</DestinationCount>
      <ParkingOfferID>String</ParkingOfferID>
      <ParkingOfferTotalPrice>0</ParkingOfferTotalPrice>
      <ParkingOfferArrivalDateTime>0001-01-01T00:00:00</ParkingOfferArrivalDateTime>
      <ParkingOfferDepartureDateTime>0001-01-01T00:00:00</ParkingOfferDepartureDateTime>
      <ParkingOfferAirportCode>String</ParkingOfferAirportCode>
      <ItineraryFormatted>String</ItineraryFormatted>
    </Booking>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>