Agentivity API

<back to all web services

GetActiveUnsoldAirBookings

The following routes are available for this service:
GET/ActiveUnsoldAirBookings
GetActiveUnsoldAirBookings Parameters:
NameParameterData TypeRequiredDescription
TravelDateStartquerystringYesDate in format YYYYMMDD
TravelDateEndquerystringNoDate in format YYYYMMDD
CarrierCodequerystringNoTwo letter code for carrier
PNRTicketedquerystringNoReturn only PNRs that are ticketed/all
IncludeItineraryquerybooleanNoInclude Itinerary in the response
ItineraryFormattingqueryintegerNoIndicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
RepeatquerystringNoRepeat
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
AccountquerystringNoComma Delimited List of Accounts
DestinationCityquerystringNoDestination city 3 letters code
BookingClassquerystringNoCabin booking class
OriginCityquerystringNoOrigin city 3 letters code
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)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
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
ActiveUnsoldAirBookings Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
OwningAgencyLocationIDformstringNo
GdsCodeformstringNo
PrimaryPaxformstringNo
OwningConsultantformstringNo
OwningConsultantIDformstringNo
AccountformstringNo
PrimaryCarrierCodeformstringNo
FiledFareformstringNo
TravelDateformDateTime?No
DestinationCitiesformstringNo
BookingClassesformstringNo
AgentivityRefformintNo
ItineraryformItinerarySegmentsCollectionNo
ItineraryFormattedformstringNo
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
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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 //ActiveUnsoldAirBookings 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":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","GdsCode":"String","PrimaryPax":"String","OwningConsultant":"String","OwningConsultantID":"String","Account":"String","AgentivityRef":0,"PrimaryCarrierCode":"String","FiledFare":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DestinationCities":"String","BookingClasses":"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"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}