Agentivity API

GetPNRSegments

The following routes are available for this service:
GET	/PNRSegments

**GetPNRSegments** Parameters:
Name	Parameter	Data Type	Required	Description
RecordLocator	query	string	Yes	Record locator
PNRCreationDate	query	string	No	Date in format YYYYMMDD
SegmentType	query	string	No	Type of segment
PassiveSegmentType	query	string	No	Type of passive segment

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<TItem>	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**PNRSegments** Parameters:
Name	Parameter	Data Type	Required	Description
Summary	form	PNRSummary	No
Segments	form	Segments	No

**PNRSummary** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
AirlineReferences	form	AirlineReferences	No
Tickets	form	PNRSummaryTickets	No

**HostSystem** Parameters:
Name	Parameter	Data Type	Required	Description
Vendor	form	string	No
VendorLocator	form	string	No

**PNRSummaryTicket** Parameters:
Name	Parameter	Data Type	Required
TktNumber	form	string	No
Passenger	form	PassengerName	No
Coupons	form	Coupons	No

**PassengerName** Parameters:
Name	Parameter	Data Type	Required	Description
LastName	form	string	No
FirstName	form	string	No

**Coupon** Parameters:
Name	Parameter	Data Type	Required
CouponSequenceNbr	form	string	No
CouponBoardPoint	form	string	No
CouponOffPoint	form	string	No
Carrier	form	string	No
FlightNbr	form	string	No
FlightDate	form	string	No
FlightTime	form	string	No

**Segments** Parameters:
Name	Parameter	Data Type	Required
AirSegments	form	List<AirSegment>	No
CarSegments	form	List<CarSegment>	No
HotelSegments	form	List<HotelSegmentDepreciated>	No
PassiveSegments	form	List<PassiveSegment>	No

**AirSegment** Parameters:
Name	Parameter	Data Type	Required
AirSegmentNbr	form	int	No
SegmentStatus	form	string	No
DepartureDate	form	string	No
DepartureTime	form	string	No
CarrierCode	form	string	No
BoardPoint	form	string	No
OffPoint	form	string	No
FlightNbr	form	string	No
BookingCode	form	string	No
ArrivalTime	form	string	No
ChangeOfDay	form	string	No
ConnectionIndicator	form	string	No
OperatingCarrierCode	form	string	No
OperatingCarrierName	form	string	No
JourneyTime	form	string	No
NbrSeats	form	int	No
SeatingData	form	SeatingData	No

**Seat** Parameters:
Name	Parameter	Data Type	Required	Description
SeatLocation	form	string	No
SeatStatusCode	form	string	No

**CarSegment** Parameters:
Name	Parameter	Data Type	Required
CarSegmentNbr	form	int	No
SegmentStatus	form	string	No
PickUpDate	form	string	No
PickUpTime	form	string	No
AirportCode	form	string	No
CarLocationCategory	form	string	No
DropOffDate	form	string	No
DropOffTime	form	string	No
ConfirmationNbr	form	string	No
CarVendorCode	form	string	No
CarRateType	form	string	No
CarRateCode	form	string	No
CarType	form	string	No
CarYieldManagementNbr	form	string	No
RateAmount	form	string	No
RateGuaranteeIndicator	form	string	No
MilesKilometerIndicator	form	string	No
DistanceAllowance	form	string	No
DistanceRateAmount	form	string	No
CurrencyCode	form	string	No
NbrOfCars	form	int	No

**HotelSegmentDepreciated** Parameters:
Name	Parameter	Data Type	Required
HotelSegmentNbr	form	string	No
StatusCode	form	string	No
ArrivalDate	form	string	No
DepartureDate	form	string	No
PropertyName	form	string	No
ConfirmationNbr	form	string	No
Currency	form	string	No
Rate	form	string	No
RoomBookingCode	form	string	No
NbrNights	form	int	No
MultiLevelRateCode	form	string	No
NbrRooms	form	int	No
BookedInName	form	string	No
ServiceInformation	form	string	No
PropertyCityCode	form	string	No
SegmentStatus	form	string	No
HotelVendorCode	form	string	No

**PassiveSegment** Parameters:
Name	Parameter	Data Type	Required
SegmentStatus	form	string	No
StartDate	form	string	No
DepartureDate	form	string	No
NbrNights	form	string	No
VendorCode	form	string	No
CityCode	form	string	No
SegmentType	form	string	No
Text	form	string	No
Passenger	form	string	No
Address	form	string	No
BookingReasonCode	form	string	No
BookingSource	form	string	No
CommissionInformation	form	string	No
ConfirmationNumber	form	string	No
RateCode	form	string	No
RateQuoted	form	string	No
RateAccessCode	form	string	No
PropertyName	form	string	No
PropertyNumber	form	string	No
ServiceInformation	form	string	No

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 //PNRSegments 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>
    <PNRSegments>
      <Summary>
        <RecordLocator>String</RecordLocator>
        <AirlineReferences>
          <HostSystem>
            <Vendor>String</Vendor>
            <VendorLocator>String</VendorLocator>
          </HostSystem>
        </AirlineReferences>
        <Tickets>
          <Ticket>
            <TktNumber>String</TktNumber>
            <Passenger>
              <LastName>String</LastName>
              <FirstName>String</FirstName>
            </Passenger>
            <Coupons>
              <Coupon>
                <CouponSequenceNbr>String</CouponSequenceNbr>
                <CouponBoardPoint>String</CouponBoardPoint>
                <CouponOffPoint>String</CouponOffPoint>
                <Carrier>String</Carrier>
                <FlightNbr>String</FlightNbr>
                <FlightDate>String</FlightDate>
                <FlightTime>String</FlightTime>
              </Coupon>
            </Coupons>
          </Ticket>
        </Tickets>
      </Summary>
      <Segments>
        <AirSegments>
          <AirSegment>
            <AirSegmentNbr>0</AirSegmentNbr>
            <ArrivalTime>String</ArrivalTime>
            <BoardPoint>String</BoardPoint>
            <BookingCode>String</BookingCode>
            <CarrierCode>String</CarrierCode>
            <ChangeOfDay>String</ChangeOfDay>
            <ConnectionIndicator>String</ConnectionIndicator>
            <DepartureDate>String</DepartureDate>
            <DepartureTime>String</DepartureTime>
            <FlightNbr>String</FlightNbr>
            <JourneyTime>String</JourneyTime>
            <NbrSeats>0</NbrSeats>
            <OffPoint>String</OffPoint>
            <OperatingCarrierCode>String</OperatingCarrierCode>
            <OperatingCarrierName>String</OperatingCarrierName>
            <SeatingData>
              <Seat>
                <SeatLocation>String</SeatLocation>
                <SeatStatusCode>String</SeatStatusCode>
              </Seat>
            </SeatingData>
            <SegmentStatus>String</SegmentStatus>
          </AirSegment>
        </AirSegments>
        <CarSegments>
          <CarSegment>
            <AirportCode>String</AirportCode>
            <CarLocationCategory>String</CarLocationCategory>
            <CarRateCode>String</CarRateCode>
            <CarRateType>String</CarRateType>
            <CarSegmentNbr>0</CarSegmentNbr>
            <CarType>String</CarType>
            <CarVendorCode>String</CarVendorCode>
            <CarYieldManagementNbr>String</CarYieldManagementNbr>
            <ConfirmationNbr>String</ConfirmationNbr>
            <CurrencyCode>String</CurrencyCode>
            <DistanceAllowance>String</DistanceAllowance>
            <DistanceRateAmount>String</DistanceRateAmount>
            <DropOffDate>String</DropOffDate>
            <DropOffTime>String</DropOffTime>
            <MilesKilometerIndicator>String</MilesKilometerIndicator>
            <NbrOfCars>0</NbrOfCars>
            <PickUpDate>String</PickUpDate>
            <PickUpTime>String</PickUpTime>
            <RateAmount>String</RateAmount>
            <RateGuaranteeIndicator>String</RateGuaranteeIndicator>
            <SegmentStatus>String</SegmentStatus>
          </CarSegment>
        </CarSegments>
        <HotelSegments>
          <Segment>
            <HotelSegmentNbr>String</HotelSegmentNbr>
            <StatusCode>String</StatusCode>
            <ArrivalDate>String</ArrivalDate>
            <DepartureDate>String</DepartureDate>
            <PropertyName>String</PropertyName>
            <ConfirmationNbr>String</ConfirmationNbr>
            <Currency>String</Currency>
            <Rate>String</Rate>
            <RoomBookingCode>String</RoomBookingCode>
            <NbrNights>0</NbrNights>
            <MultiLevelRateCode>String</MultiLevelRateCode>
            <NbrRooms>0</NbrRooms>
            <BookedInName>String</BookedInName>
            <ServiceInformation>String</ServiceInformation>
            <PropertyCityCode>String</PropertyCityCode>
            <SegmentStatus>String</SegmentStatus>
            <HotelVendorCode>String</HotelVendorCode>
          </Segment>
        </HotelSegments>
        <PassiveSegments>
          <PassiveSegment>
            <Address>String</Address>
            <BookingReasonCode>String</BookingReasonCode>
            <BookingSource>String</BookingSource>
            <CityCode>String</CityCode>
            <CommissionInformation>String</CommissionInformation>
            <ConfirmationNumber>String</ConfirmationNumber>
            <DepartureDate>String</DepartureDate>
            <NbrNights>String</NbrNights>
            <Passenger>String</Passenger>
            <PropertyName>String</PropertyName>
            <PropertyNumber>String</PropertyNumber>
            <RateAccessCode>String</RateAccessCode>
            <RateCode>String</RateCode>
            <RateQuoted>String</RateQuoted>
            <SegmentStatus>String</SegmentStatus>
            <SegmentType>String</SegmentType>
            <ServiceInformation>String</ServiceInformation>
            <StartDate>String</StartDate>
            <Text>String</Text>
            <VendorCode>String</VendorCode>
          </PassiveSegment>
        </PassiveSegments>
      </Segments>
    </PNRSegments>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>