Agentivity API

<back to all web services

GetBookingsCreated

The following routes are available for this service:
GET/BookingsCreated
GetBookingsCreated Parameters:
NameParameterData TypeRequiredDescription
IncludeCTFieldsquerystringNoIncludes CTCM and CTCE in results
AccountquerystringNoComma Delimited List of Accounts
HasAccountquerybooleanNoReturn only PNRs with/without an account
HasEmailquerybooleanNoReturn only PNRs with/without an email address
HasHotelquerybooleanNoReturn only PNRs with/without a hotel
HasMobilequerybooleanNoReturn only PNRs with/without a mobile number
IncludeItineraryquerybooleanNoInclude Itinerary in the response
IsVipquerybooleanNoReturn only PNRs that are or are not flagged as VIP bookings
ItineraryFormattingqueryintegerNoIndicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
MinSegmentsqueryintegerNoReturn only PNRs that equal or exceed a certain number of segments
MissingEmailOrPhonequerybooleanNoReturn only PNRs with/without an email address OR a mobile number
PNRCreationDateEndquerystringYesDate in format YYYYMMDD
PNRCreationDateStartquerystringYesDate in format YYYYMMDD
PNRCancelledquerybooleanNoReturn only PNRs that are cancelled(Y)/not cancelled(N)/all
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
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
BookingCreated Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
OwningAgencyLocationIDformstringNo
AccountformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
PNRTicketedformstringNo
PNRTicketedDateformDateTime?No
PNRCancelledformstringNo
TravelDateformDateTime?No
CancelledTravelDateformDateTime?No
PassengersformstringNo
MobileformstringNo
EmailsformstringNo
DestinationCountformintNo
IsVipformboolNo
CTCMformstringNo
CTCEformstringNo
ItineraryformItinerarySegmentsCollectionNo
ItineraryFormattedformstringNo
CarbonTonnageformdouble?No
ItinerarySegment Parameters:
NameParameterData TypeRequiredDescription
SegmentTypeformstringNo
SegmentNbrformintNo
BoardPointformstringNo
OffPointformstringNo
OperatorCodeformstringNo
OperatorServiceformstringNo
SegmentStatusformstringNo
DepartureTimeFormattedformstringNo
ArrivalTimeFormattedformstringNo
ChangeOfDayFormattedformstringNo
ServiceCodeformstringNo
StartDateformstringNo
EndDateformstringNo
TicketNumberformstringNo
VendorLocatorsquerystringNoComma separated list of vendor locators
EquipmentCodeformstringNo
EquipmentformstringNo

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 //BookingsCreated 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":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","PNRTicketed":"String","PNRTicketedDate":"\/Date(-62135596800000-0000)\/","PNRCancelled":"String","TravelDate":"\/Date(-62135596800000-0000)\/","CancelledTravelDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","Mobile":"String","Emails":"String","DestinationCount":0,"IsVip":false,"CTCM":"String","CTCE":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String","CarbonTonnage":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}