Agentivity API

<back to all web services

GetPassengerAirSegmentsWithMaxBookingsFlag

The following routes are available for this service:
GET/PassengerAirSegmentsWithMaxBookingsFlag
GetPassengerAirSegmentsWithMaxBookingsFlag Parameters:
NameParameterData TypeRequiredDescription
DepartureDateStartquerystringYesDate in format YYYYMMDD
DepartureDateEndquerystringYesDate in format YYYYMMDD
PNRCreationDatequerystringNoDate in format YYYYMMDD
PNRTicketedquerystringNoReturn only PNRs that are ticketed/all
MaxBookingsAllowedquerystringYesMaximum number of bookings per flight before warning
MaxBookingsIsExceededFlagquerystringNoFilter the report to only show cases where the max value is exceeded
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
PassengerAirSegmentWithMaxBookingsFlag Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
OwningAgencyLocationIDformstringNo
AccountformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
PassengerformstringNo
FlightNbrformstringNo
CarrierCodeformstringNo
DepartureCityformstringNo
DepartureDateformstringNo
DepartureTimeformstringNo
ArrivalCityformstringNo
ArrivalDateformstringNo
ArrivalTimeformstringNo
BookingClassCodeformstringNo
PNRTicketedformstringNo
BookingsCountformintNo
MaxBookingsCountformintNo
MaxBookingsCountExceededFlagformboolNo

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 //PassengerAirSegmentsWithMaxBookingsFlag 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>
    <Segment>
      <Account>String</Account>
      <ArrivalCity>String</ArrivalCity>
      <ArrivalDate>String</ArrivalDate>
      <ArrivalTime>String</ArrivalTime>
      <BookingClassCode>String</BookingClassCode>
      <BookingsCount>0</BookingsCount>
      <CarrierCode>String</CarrierCode>
      <DepartureCity>String</DepartureCity>
      <DepartureDate>String</DepartureDate>
      <DepartureTime>String</DepartureTime>
      <FlightNbr>String</FlightNbr>
      <MaxBookingsCount>0</MaxBookingsCount>
      <MaxBookingsCountExceededFlag>false</MaxBookingsCountExceededFlag>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <PNRTicketed>String</PNRTicketed>
      <Passenger>String</Passenger>
      <RecordLocator>String</RecordLocator>
    </Segment>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>