Agentivity API

<back to all web services

GetPNRSegments

import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetPNRSegments : PagingMetadata
{
    /**
    * Record locator
    */
    // @DataMember
    public var recordLocator:String

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var pnrCreationDate:String

    /**
    * Type of segment
    */
    // @DataMember
    public var segmentType:[String]

    /**
    * Type of passive segment
    */
    // @DataMember
    public var passiveSegmentType:[String]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case recordLocator
        case pnrCreationDate
        case segmentType
        case passiveSegmentType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        recordLocator = try container.decodeIfPresent(String.self, forKey: .recordLocator)
        pnrCreationDate = try container.decodeIfPresent(String.self, forKey: .pnrCreationDate)
        segmentType = try container.decodeIfPresent([String].self, forKey: .segmentType) ?? []
        passiveSegmentType = try container.decodeIfPresent([String].self, forKey: .passiveSegmentType) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if recordLocator != nil { try container.encode(recordLocator, forKey: .recordLocator) }
        if pnrCreationDate != nil { try container.encode(pnrCreationDate, forKey: .pnrCreationDate) }
        if segmentType != nil { try container.encode(segmentType, forKey: .segmentType) }
        if passiveSegmentType != nil { try container.encode(passiveSegmentType, forKey: .passiveSegmentType) }
    }
}

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public class PagingMetadata : Codable
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public var offset:String

    /**
    * Number of records to return (PageSize)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public var limit:String

    /**
    * Total Number of Records in a Full Reponse (if no paging)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public var totalRecords:Int

    /**
    * Total Number of Records in this Reponse (on this page)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public var responseRecords:Int

    required public init(){}
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class GetPNRSegmentsResponse : CollectionResponse<PNRSegments>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class CollectionResponse<TItem : Codable> : Codable
{
    // @DataMember(Order=1)
    public var responseMetadata:ResponseMetadata

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var responseReport:[ApiRequestPerHour]

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var responseError:AgentivityError

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class ResponseMetadata : Codable
{
    // @DataMember(Order=0)
    public var success:Bool

    // @DataMember(Order=1)
    public var hasCache:Bool

    // @DataMember(Order=2)
    public var hasPaging:Bool

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var cacheMetadata:CacheMetadata

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var pagingMetadata:PagingMetadata

    required public init(){}
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public class CacheMetadata : Codable
{
    // @DataMember(Order=1)
    public var cachedAt:Date

    // @DataMember(Order=2)
    public var cacheExpiresAt:Date

    // @DataMember(Order=0)
    public var isFromCache:Bool

    required public init(){}
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
public class ApiRequestPerHour : Codable
{
    // @DataMember(Order=10)
    public var requestDate:Date

    // @DataMember(Order=100)
    public var hour0:Int

    // @DataMember(Order=110)
    public var hour1:Int

    // @DataMember(Order=120)
    public var hour2:Int

    // @DataMember(Order=130)
    public var hour3:Int

    // @DataMember(Order=140)
    public var hour4:Int

    // @DataMember(Order=150)
    public var hour5:Int

    // @DataMember(Order=160)
    public var hour6:Int

    // @DataMember(Order=170)
    public var hour7:Int

    // @DataMember(Order=180)
    public var hour8:Int

    // @DataMember(Order=190)
    public var hour9:Int

    // @DataMember(Order=200)
    public var hour10:Int

    // @DataMember(Order=210)
    public var hour11:Int

    // @DataMember(Order=220)
    public var hour12:Int

    // @DataMember(Order=230)
    public var hour13:Int

    // @DataMember(Order=240)
    public var hour14:Int

    // @DataMember(Order=250)
    public var hour15:Int

    // @DataMember(Order=260)
    public var hour16:Int

    // @DataMember(Order=270)
    public var hour17:Int

    // @DataMember(Order=280)
    public var hour18:Int

    // @DataMember(Order=290)
    public var hour19:Int

    // @DataMember(Order=300)
    public var hour20:Int

    // @DataMember(Order=310)
    public var hour21:Int

    // @DataMember(Order=320)
    public var hour22:Int

    // @DataMember(Order=330)
    public var hour23:Int

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class AgentivityError : Codable
{
    // @DataMember
    public var errorCode:String

    // @DataMember
    public var message:String

    // @DataMember
    public var statusCode:String

    // @DataMember
    public var verboseMessage:String

    required public init(){}
}

// @DataContract(Name="PNRSegments", Namespace="schemas.agentivity.com/types")
public class PNRSegments : Codable
{
    // @DataMember(Order=10)
    public var summary:PNRSummary

    // @DataMember(Order=20)
    public var segments:Segments

    required public init(){}
}

// @DataContract(Name="PNRSummary", Namespace="schemas.agentivity.com/types")
public class PNRSummary : Codable
{
    // @DataMember(Order=1)
    public var recordLocator:String

    // @DataMember(Order=2)
    public var airlineReferences:AirlineReferences

    // @DataMember(Order=3)
    public var tickets:PNRSummaryTickets

    required public init(){}
}

public class AirlineReferences : List<HostSystem>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class HostSystem : Codable
{
    // @DataMember(Order=1)
    public var vendor:String

    // @DataMember(Order=2)
    public var vendorLocator:String

    required public init(){}
}

public class PNRSummaryTickets : List<PNRSummaryTicket>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class PNRSummaryTicket : Codable
{
    // @DataMember(Order=1)
    public var tktNumber:String

    // @DataMember(Order=2)
    public var passenger:PassengerName

    // @DataMember(Order=3)
    public var coupons:Coupons

    required public init(){}
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class PassengerName : Codable
{
    // @DataMember(Order=1)
    public var lastName:String

    // @DataMember(Order=2)
    public var firstName:String

    required public init(){}
}

public class Coupons : List<Coupon>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class Coupon : Codable
{
    // @DataMember(Order=1)
    public var couponSequenceNbr:String

    // @DataMember(Order=2)
    public var couponBoardPoint:String

    // @DataMember(Order=3)
    public var couponOffPoint:String

    // @DataMember(Order=4)
    public var carrier:String

    // @DataMember(Order=5)
    public var flightNbr:String

    // @DataMember(Order=6)
    public var flightDate:String

    // @DataMember(Order=7)
    public var flightTime:String

    required public init(){}
}

// @DataContract(Name="Segments", Namespace="schemas.agentivity.com/types")
public class Segments : Codable
{
    // @DataMember(Order=2, EmitDefaultValue=false)
    public var airSegments:[AirSegment]

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var carSegments:[CarSegment]

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var hotelSegments:[HotelSegmentDepreciated]

    // @DataMember(Order=5, EmitDefaultValue=false)
    public var passiveSegments:[PassiveSegment]

    required public init(){}
}

// @DataContract(Name="AirSegment", Namespace="schemas.agentivity.com/types")
public class AirSegment : Codable
{
    // @DataMember
    public var airSegmentNbr:Int

    // @DataMember
    public var segmentStatus:String

    // @DataMember
    public var departureDate:String

    // @DataMember
    public var departureTime:String

    // @DataMember
    public var carrierCode:String

    // @DataMember
    public var boardPoint:String

    // @DataMember
    public var offPoint:String

    // @DataMember
    public var flightNbr:String

    // @DataMember
    public var bookingCode:String

    // @DataMember
    public var arrivalTime:String

    // @DataMember
    public var changeOfDay:String

    // @DataMember
    public var connectionIndicator:String

    // @DataMember
    public var operatingCarrierCode:String

    // @DataMember
    public var operatingCarrierName:String

    // @DataMember
    public var journeyTime:String

    // @DataMember
    public var nbrSeats:Int

    // @DataMember(EmitDefaultValue=false)
    public var seatingData:SeatingData

    required public init(){}
}

public class SeatingData : List<Seat>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class Seat : Codable
{
    // @DataMember(Order=1)
    public var seatLocation:String

    // @DataMember(Order=2)
    public var seatStatusCode:String

    required public init(){}
}

// @DataContract(Name="CarSegment", Namespace="schemas.agentivity.com/types")
public class CarSegment : Codable
{
    // @DataMember
    public var carSegmentNbr:Int

    // @DataMember
    public var segmentStatus:String

    // @DataMember
    public var pickUpDate:String

    // @DataMember
    public var pickUpTime:String

    // @DataMember
    public var airportCode:String

    // @DataMember
    public var carLocationCategory:String

    // @DataMember
    public var dropOffDate:String

    // @DataMember
    public var dropOffTime:String

    // @DataMember
    public var confirmationNbr:String

    // @DataMember
    public var carVendorCode:String

    // @DataMember
    public var carRateType:String

    // @DataMember
    public var carRateCode:String

    // @DataMember
    public var carType:String

    // @DataMember
    public var carYieldManagementNbr:String

    // @DataMember
    public var rateAmount:String

    // @DataMember
    public var rateGuaranteeIndicator:String

    // @DataMember
    public var milesKilometerIndicator:String

    // @DataMember
    public var distanceAllowance:String

    // @DataMember
    public var distanceRateAmount:String

    // @DataMember
    public var currencyCode:String

    // @DataMember
    public var nbrOfCars:Int

    required public init(){}
}

// @DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")
public class HotelSegmentDepreciated : Codable
{
    // @DataMember(Order=1)
    public var hotelSegmentNbr:String

    // @DataMember(Order=4)
    public var statusCode:String

    // @DataMember(Order=5)
    public var arrivalDate:String

    // @DataMember(Order=6)
    public var departureDate:String

    // @DataMember(Order=7)
    public var propertyName:String

    // @DataMember(Order=16)
    public var confirmationNbr:String

    // @DataMember(Order=17)
    public var currency:String

    // @DataMember(Order=18)
    public var rate:String

    // @DataMember(Order=19)
    public var roomBookingCode:String

    // @DataMember(Order=20)
    public var nbrNights:Int

    // @DataMember(Order=21)
    public var multiLevelRateCode:String

    // @DataMember(Order=22)
    public var nbrRooms:Int

    // @DataMember(Order=23)
    public var bookedInName:String

    // @DataMember(Order=24)
    public var serviceInformation:String

    // @DataMember(Order=25)
    public var propertyCityCode:String

    // @DataMember(Order=26)
    public var segmentStatus:String

    // @DataMember(Order=27)
    public var hotelVendorCode:String

    required public init(){}
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class PassiveSegment : Codable
{
    // @DataMember
    public var segmentStatus:String

    // @DataMember
    public var startDate:String

    // @DataMember
    public var departureDate:String

    // @DataMember
    public var nbrNights:String

    // @DataMember
    public var vendorCode:String

    // @DataMember
    public var cityCode:String

    // @DataMember
    public var segmentType:String

    // @DataMember
    public var text:String

    // @DataMember
    public var passenger:String

    // @DataMember
    public var address:String

    // @DataMember
    public var bookingReasonCode:String

    // @DataMember
    public var bookingSource:String

    // @DataMember
    public var commissionInformation:String

    // @DataMember
    public var confirmationNumber:String

    // @DataMember
    public var rateCode:String

    // @DataMember
    public var rateQuoted:String

    // @DataMember
    public var rateAccessCode:String

    // @DataMember
    public var propertyName:String

    // @DataMember
    public var propertyNumber:String

    // @DataMember
    public var serviceInformation:String

    required public init(){}
}

Swift GetPNRSegments DTOs

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>