Agentivity API

GetPNRSegments

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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class CollectionResponse<TItem>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual List<ApiRequestPerHour> ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

    [DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")]
    public partial class HotelSegmentDepreciated
    {
        [DataMember(Order=1)]
        public virtual string HotelSegmentNbr { get; set; }

        [DataMember(Order=4)]
        public virtual string StatusCode { get; set; }

        [DataMember(Order=5)]
        public virtual string ArrivalDate { get; set; }

        [DataMember(Order=6)]
        public virtual string DepartureDate { get; set; }

        [DataMember(Order=7)]
        public virtual string PropertyName { get; set; }

        [DataMember(Order=16)]
        public virtual string ConfirmationNbr { get; set; }

        [DataMember(Order=17)]
        public virtual string Currency { get; set; }

        [DataMember(Order=18)]
        public virtual string Rate { get; set; }

        [DataMember(Order=19)]
        public virtual string RoomBookingCode { get; set; }

        [DataMember(Order=20)]
        public virtual int NbrNights { get; set; }

        [DataMember(Order=21)]
        public virtual string MultiLevelRateCode { get; set; }

        [DataMember(Order=22)]
        public virtual int NbrRooms { get; set; }

        [DataMember(Order=23)]
        public virtual string BookedInName { get; set; }

        [DataMember(Order=24)]
        public virtual string ServiceInformation { get; set; }

        [DataMember(Order=25)]
        public virtual string PropertyCityCode { get; set; }

        [DataMember(Order=26)]
        public virtual string SegmentStatus { get; set; }

        [DataMember(Order=27)]
        public virtual string HotelVendorCode { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class PassiveSegment
    {
        [DataMember]
        public virtual string SegmentStatus { get; set; }

        [DataMember]
        public virtual string StartDate { get; set; }

        [DataMember]
        public virtual string DepartureDate { get; set; }

        [DataMember]
        public virtual string NbrNights { get; set; }

        [DataMember]
        public virtual string VendorCode { get; set; }

        [DataMember]
        public virtual string CityCode { get; set; }

        [DataMember]
        public virtual string SegmentType { get; set; }

        [DataMember]
        public virtual string Text { get; set; }

        [DataMember]
        public virtual string Passenger { get; set; }

        [DataMember]
        public virtual string Address { get; set; }

        [DataMember]
        public virtual string BookingReasonCode { get; set; }

        [DataMember]
        public virtual string BookingSource { get; set; }

        [DataMember]
        public virtual string CommissionInformation { get; set; }

        [DataMember]
        public virtual string ConfirmationNumber { get; set; }

        [DataMember]
        public virtual string RateCode { get; set; }

        [DataMember]
        public virtual string RateQuoted { get; set; }

        [DataMember]
        public virtual string RateAccessCode { get; set; }

        [DataMember]
        public virtual string PropertyName { get; set; }

        [DataMember]
        public virtual string PropertyNumber { get; set; }

        [DataMember]
        public virtual string ServiceInformation { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    public partial class AirlineReferences
        : List<HostSystem>
    {
    }

    [DataContract(Name="AirSegment", Namespace="schemas.agentivity.com/types")]
    public partial class AirSegment
    {
        [DataMember]
        public virtual int AirSegmentNbr { get; set; }

        [DataMember]
        public virtual string SegmentStatus { get; set; }

        [DataMember]
        public virtual string DepartureDate { get; set; }

        [DataMember]
        public virtual string DepartureTime { get; set; }

        [DataMember]
        public virtual string CarrierCode { get; set; }

        [DataMember]
        public virtual string BoardPoint { get; set; }

        [DataMember]
        public virtual string OffPoint { get; set; }

        [DataMember]
        public virtual string FlightNbr { get; set; }

        [DataMember]
        public virtual string BookingCode { get; set; }

        [DataMember]
        public virtual string ArrivalTime { get; set; }

        [DataMember]
        public virtual string ChangeOfDay { get; set; }

        [DataMember]
        public virtual string ConnectionIndicator { get; set; }

        [DataMember]
        public virtual string OperatingCarrierCode { get; set; }

        [DataMember]
        public virtual string OperatingCarrierName { get; set; }

        [DataMember]
        public virtual string JourneyTime { get; set; }

        [DataMember]
        public virtual int NbrSeats { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual SeatingData SeatingData { get; set; }
    }

    [DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")]
    public partial class ApiRequestPerHour
    {
        [DataMember(Order=10)]
        public virtual DateTime RequestDate { get; set; }

        [DataMember(Order=100)]
        public virtual int Hour0 { get; set; }

        [DataMember(Order=110)]
        public virtual int Hour1 { get; set; }

        [DataMember(Order=120)]
        public virtual int Hour2 { get; set; }

        [DataMember(Order=130)]
        public virtual int Hour3 { get; set; }

        [DataMember(Order=140)]
        public virtual int Hour4 { get; set; }

        [DataMember(Order=150)]
        public virtual int Hour5 { get; set; }

        [DataMember(Order=160)]
        public virtual int Hour6 { get; set; }

        [DataMember(Order=170)]
        public virtual int Hour7 { get; set; }

        [DataMember(Order=180)]
        public virtual int Hour8 { get; set; }

        [DataMember(Order=190)]
        public virtual int Hour9 { get; set; }

        [DataMember(Order=200)]
        public virtual int Hour10 { get; set; }

        [DataMember(Order=210)]
        public virtual int Hour11 { get; set; }

        [DataMember(Order=220)]
        public virtual int Hour12 { get; set; }

        [DataMember(Order=230)]
        public virtual int Hour13 { get; set; }

        [DataMember(Order=240)]
        public virtual int Hour14 { get; set; }

        [DataMember(Order=250)]
        public virtual int Hour15 { get; set; }

        [DataMember(Order=260)]
        public virtual int Hour16 { get; set; }

        [DataMember(Order=270)]
        public virtual int Hour17 { get; set; }

        [DataMember(Order=280)]
        public virtual int Hour18 { get; set; }

        [DataMember(Order=290)]
        public virtual int Hour19 { get; set; }

        [DataMember(Order=300)]
        public virtual int Hour20 { get; set; }

        [DataMember(Order=310)]
        public virtual int Hour21 { get; set; }

        [DataMember(Order=320)]
        public virtual int Hour22 { get; set; }

        [DataMember(Order=330)]
        public virtual int Hour23 { get; set; }
    }

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Name="CarSegment", Namespace="schemas.agentivity.com/types")]
    public partial class CarSegment
    {
        [DataMember]
        public virtual int CarSegmentNbr { get; set; }

        [DataMember]
        public virtual string SegmentStatus { get; set; }

        [DataMember]
        public virtual string PickUpDate { get; set; }

        [DataMember]
        public virtual string PickUpTime { get; set; }

        [DataMember]
        public virtual string AirportCode { get; set; }

        [DataMember]
        public virtual string CarLocationCategory { get; set; }

        [DataMember]
        public virtual string DropOffDate { get; set; }

        [DataMember]
        public virtual string DropOffTime { get; set; }

        [DataMember]
        public virtual string ConfirmationNbr { get; set; }

        [DataMember]
        public virtual string CarVendorCode { get; set; }

        [DataMember]
        public virtual string CarRateType { get; set; }

        [DataMember]
        public virtual string CarRateCode { get; set; }

        [DataMember]
        public virtual string CarType { get; set; }

        [DataMember]
        public virtual string CarYieldManagementNbr { get; set; }

        [DataMember]
        public virtual string RateAmount { get; set; }

        [DataMember]
        public virtual string RateGuaranteeIndicator { get; set; }

        [DataMember]
        public virtual string MilesKilometerIndicator { get; set; }

        [DataMember]
        public virtual string DistanceAllowance { get; set; }

        [DataMember]
        public virtual string DistanceRateAmount { get; set; }

        [DataMember]
        public virtual string CurrencyCode { get; set; }

        [DataMember]
        public virtual int NbrOfCars { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Coupon
    {
        [DataMember(Order=1)]
        public virtual string CouponSequenceNbr { get; set; }

        [DataMember(Order=2)]
        public virtual string CouponBoardPoint { get; set; }

        [DataMember(Order=3)]
        public virtual string CouponOffPoint { get; set; }

        [DataMember(Order=4)]
        public virtual string Carrier { get; set; }

        [DataMember(Order=5)]
        public virtual string FlightNbr { get; set; }

        [DataMember(Order=6)]
        public virtual string FlightDate { get; set; }

        [DataMember(Order=7)]
        public virtual string FlightTime { get; set; }
    }

    public partial class Coupons
        : List<Coupon>
    {
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetPNRSegments
        : PagingMetadata
    {
        ///<summary>
        ///Record locator
        ///</summary>
        [DataMember]
        public virtual string RecordLocator { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string PNRCreationDate { get; set; }

        ///<summary>
        ///Type of segment
        ///</summary>
        [DataMember]
        public virtual string[] SegmentType { get; set; }

        ///<summary>
        ///Type of passive segment
        ///</summary>
        [DataMember]
        public virtual string[] PassiveSegmentType { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class GetPNRSegmentsResponse
        : CollectionResponse<PNRSegments>
    {
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class HostSystem
    {
        [DataMember(Order=1)]
        public virtual string Vendor { get; set; }

        [DataMember(Order=2)]
        public virtual string VendorLocator { get; set; }
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")]
        public virtual int TotalRecords { get; set; }

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")]
        public virtual int ResponseRecords { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class PassengerName
    {
        [DataMember(Order=1)]
        public virtual string LastName { get; set; }

        [DataMember(Order=2)]
        public virtual string FirstName { get; set; }
    }

    [DataContract(Name="PNRSegments", Namespace="schemas.agentivity.com/types")]
    public partial class PNRSegments
    {
        [DataMember(Order=10)]
        public virtual PNRSummary Summary { get; set; }

        [DataMember(Order=20)]
        public virtual Segments Segments { get; set; }
    }

    [DataContract(Name="PNRSummary", Namespace="schemas.agentivity.com/types")]
    public partial class PNRSummary
    {
        [DataMember(Order=1)]
        public virtual string RecordLocator { get; set; }

        [DataMember(Order=2)]
        public virtual AirlineReferences AirlineReferences { get; set; }

        [DataMember(Order=3)]
        public virtual PNRSummaryTickets Tickets { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class PNRSummaryTicket
    {
        [DataMember(Order=1)]
        public virtual string TktNumber { get; set; }

        [DataMember(Order=2)]
        public virtual PassengerName Passenger { get; set; }

        [DataMember(Order=3)]
        public virtual Coupons Coupons { get; set; }
    }

    public partial class PNRSummaryTickets
        : List<PNRSummaryTicket>
    {
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Seat
    {
        [DataMember(Order=1)]
        public virtual string SeatLocation { get; set; }

        [DataMember(Order=2)]
        public virtual string SeatStatusCode { get; set; }
    }

    public partial class SeatingData
        : List<Seat>
    {
    }

    [DataContract(Name="Segments", Namespace="schemas.agentivity.com/types")]
    public partial class Segments
    {
        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual List<AirSegment> AirSegments { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual List<CarSegment> CarSegments { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual List<HotelSegmentDepreciated> HotelSegments { get; set; }

        [DataMember(Order=5, EmitDefaultValue=false)]
        public virtual List<PassiveSegment> PassiveSegments { get; set; }
    }

}

C# GetPNRSegments DTOs

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>