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 .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 //ActiveUnsoldAirBookings 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>
    <Item>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <GdsCode>String</GdsCode>
      <PrimaryPax>String</PrimaryPax>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <Account>String</Account>
      <AgentivityRef>0</AgentivityRef>
      <PrimaryCarrierCode>String</PrimaryCarrierCode>
      <FiledFare>String</FiledFare>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <DestinationCities>String</DestinationCities>
      <BookingClasses>String</BookingClasses>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
        </ItinerarySegment>
      </Itinerary>
      <ItineraryFormatted>String</ItineraryFormatted>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>