Agentivity API

<back to all web services

GetBookingsWithDestinationsByTraveller

The following routes are available for this service:
GET/BookingsWithDestinations/Traveller
GetBookingsWithDestinationsByTraveller Parameters:
NameParameterData TypeRequiredDescription
TravellerReferencequeryintegerNoTraveller CRM ID or reference
TravellerGUIDquerystringNoAgentivity Traveller GUID
TravellerEmailquerystringNoAn email of a traveller
TravellerPhoneNbrquerystringNoTraveller phone number
TravelDateStartquerystringNoDate in format YYYYMMDD
TravelDateEndquerystringNoDate in format YYYYMMDD
PNRTicketedquerystringNoReturn only PNRs that are ticketed/all
SortOrderquerystringNoSort Order
DestinationCitiesquerystringNoComma Delimited List of Destination City Codes
DestinationCountriesquerystringNoComma Delimited List of Destination Country Codes
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
BookingWithDestinationsOld2 Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformstringNo
PNRformstringNo
RecordLocatorformstringNo
PNRCreationDateformstringNo
TravelDateformstringNo
PNRTicketedformstringNo
PNRCancelledformstringNo
AccountformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
LastActionConsultantIDformstringNo
DestinationCitiesformstringNo
DestinationCountriesformstringNo
OwningAgencyLocationIDformstringNo
OwningAgencyLocationNameformstringNo

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 //BookingsWithDestinations/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":[{"AgentivityRef":"String","PNR":"String","RecordLocator":"String","PNRCreationDate":"String","TravelDate":"String","PNRTicketed":"String","PNRCancelled":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","LastActionConsultantID":"String","DestinationCities":"String","DestinationCountries":"String","OwningAgencyLocationID":"String","OwningAgencyLocationName":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}