Agentivity API

GetPNRSegments

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

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

Namespace Global

    Namespace AgentivityAPI.ServiceModel

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CollectionResponse(Of TItem)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property ResponseReport As List(Of ApiRequestPerHour)

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        End Class

        <DataContract(Name:="Segment", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class HotelSegmentDepreciated
            <DataMember(Order:=1)>
            Public Overridable Property HotelSegmentNbr As String

            <DataMember(Order:=4)>
            Public Overridable Property StatusCode As String

            <DataMember(Order:=5)>
            Public Overridable Property ArrivalDate As String

            <DataMember(Order:=6)>
            Public Overridable Property DepartureDate As String

            <DataMember(Order:=7)>
            Public Overridable Property PropertyName As String

            <DataMember(Order:=16)>
            Public Overridable Property ConfirmationNbr As String

            <DataMember(Order:=17)>
            Public Overridable Property Currency As String

            <DataMember(Order:=18)>
            Public Overridable Property Rate As String

            <DataMember(Order:=19)>
            Public Overridable Property RoomBookingCode As String

            <DataMember(Order:=20)>
            Public Overridable Property NbrNights As Integer

            <DataMember(Order:=21)>
            Public Overridable Property MultiLevelRateCode As String

            <DataMember(Order:=22)>
            Public Overridable Property NbrRooms As Integer

            <DataMember(Order:=23)>
            Public Overridable Property BookedInName As String

            <DataMember(Order:=24)>
            Public Overridable Property ServiceInformation As String

            <DataMember(Order:=25)>
            Public Overridable Property PropertyCityCode As String

            <DataMember(Order:=26)>
            Public Overridable Property SegmentStatus As String

            <DataMember(Order:=27)>
            Public Overridable Property HotelVendorCode As String
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassiveSegment
            <DataMember>
            Public Overridable Property SegmentStatus As String

            <DataMember>
            Public Overridable Property StartDate As String

            <DataMember>
            Public Overridable Property DepartureDate As String

            <DataMember>
            Public Overridable Property NbrNights As String

            <DataMember>
            Public Overridable Property VendorCode As String

            <DataMember>
            Public Overridable Property CityCode As String

            <DataMember>
            Public Overridable Property SegmentType As String

            <DataMember>
            Public Overridable Property Text As String

            <DataMember>
            Public Overridable Property Passenger As String

            <DataMember>
            Public Overridable Property Address As String

            <DataMember>
            Public Overridable Property BookingReasonCode As String

            <DataMember>
            Public Overridable Property BookingSource As String

            <DataMember>
            Public Overridable Property CommissionInformation As String

            <DataMember>
            Public Overridable Property ConfirmationNumber As String

            <DataMember>
            Public Overridable Property RateCode As String

            <DataMember>
            Public Overridable Property RateQuoted As String

            <DataMember>
            Public Overridable Property RateAccessCode As String

            <DataMember>
            Public Overridable Property PropertyName As String

            <DataMember>
            Public Overridable Property PropertyNumber As String

            <DataMember>
            Public Overridable Property ServiceInformation As String
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Types

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AgentivityError
            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property StatusCode As String

            <DataMember>
            Public Overridable Property VerboseMessage As String
        End Class

        Public Partial Class AirlineReferences
            Inherits List(Of HostSystem)
        End Class

        <DataContract(Name:="AirSegment", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AirSegment
            <DataMember>
            Public Overridable Property AirSegmentNbr As Integer

            <DataMember>
            Public Overridable Property SegmentStatus As String

            <DataMember>
            Public Overridable Property DepartureDate As String

            <DataMember>
            Public Overridable Property DepartureTime As String

            <DataMember>
            Public Overridable Property CarrierCode As String

            <DataMember>
            Public Overridable Property BoardPoint As String

            <DataMember>
            Public Overridable Property OffPoint As String

            <DataMember>
            Public Overridable Property FlightNbr As String

            <DataMember>
            Public Overridable Property BookingCode As String

            <DataMember>
            Public Overridable Property ArrivalTime As String

            <DataMember>
            Public Overridable Property ChangeOfDay As String

            <DataMember>
            Public Overridable Property ConnectionIndicator As String

            <DataMember>
            Public Overridable Property OperatingCarrierCode As String

            <DataMember>
            Public Overridable Property OperatingCarrierName As String

            <DataMember>
            Public Overridable Property JourneyTime As String

            <DataMember>
            Public Overridable Property NbrSeats As Integer

            <DataMember(EmitDefaultValue:=false)>
            Public Overridable Property SeatingData As SeatingData
        End Class

        <DataContract(Name:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ApiRequestPerHour
            <DataMember(Order:=10)>
            Public Overridable Property RequestDate As Date

            <DataMember(Order:=100)>
            Public Overridable Property Hour0 As Integer

            <DataMember(Order:=110)>
            Public Overridable Property Hour1 As Integer

            <DataMember(Order:=120)>
            Public Overridable Property Hour2 As Integer

            <DataMember(Order:=130)>
            Public Overridable Property Hour3 As Integer

            <DataMember(Order:=140)>
            Public Overridable Property Hour4 As Integer

            <DataMember(Order:=150)>
            Public Overridable Property Hour5 As Integer

            <DataMember(Order:=160)>
            Public Overridable Property Hour6 As Integer

            <DataMember(Order:=170)>
            Public Overridable Property Hour7 As Integer

            <DataMember(Order:=180)>
            Public Overridable Property Hour8 As Integer

            <DataMember(Order:=190)>
            Public Overridable Property Hour9 As Integer

            <DataMember(Order:=200)>
            Public Overridable Property Hour10 As Integer

            <DataMember(Order:=210)>
            Public Overridable Property Hour11 As Integer

            <DataMember(Order:=220)>
            Public Overridable Property Hour12 As Integer

            <DataMember(Order:=230)>
            Public Overridable Property Hour13 As Integer

            <DataMember(Order:=240)>
            Public Overridable Property Hour14 As Integer

            <DataMember(Order:=250)>
            Public Overridable Property Hour15 As Integer

            <DataMember(Order:=260)>
            Public Overridable Property Hour16 As Integer

            <DataMember(Order:=270)>
            Public Overridable Property Hour17 As Integer

            <DataMember(Order:=280)>
            Public Overridable Property Hour18 As Integer

            <DataMember(Order:=290)>
            Public Overridable Property Hour19 As Integer

            <DataMember(Order:=300)>
            Public Overridable Property Hour20 As Integer

            <DataMember(Order:=310)>
            Public Overridable Property Hour21 As Integer

            <DataMember(Order:=320)>
            Public Overridable Property Hour22 As Integer

            <DataMember(Order:=330)>
            Public Overridable Property Hour23 As Integer
        End Class

        <DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CacheMetadata
            <DataMember(Order:=1)>
            Public Overridable Property CachedAt As Date

            <DataMember(Order:=2)>
            Public Overridable Property CacheExpiresAt As Date

            <DataMember(Order:=0)>
            Public Overridable Property IsFromCache As Boolean
        End Class

        <DataContract(Name:="CarSegment", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CarSegment
            <DataMember>
            Public Overridable Property CarSegmentNbr As Integer

            <DataMember>
            Public Overridable Property SegmentStatus As String

            <DataMember>
            Public Overridable Property PickUpDate As String

            <DataMember>
            Public Overridable Property PickUpTime As String

            <DataMember>
            Public Overridable Property AirportCode As String

            <DataMember>
            Public Overridable Property CarLocationCategory As String

            <DataMember>
            Public Overridable Property DropOffDate As String

            <DataMember>
            Public Overridable Property DropOffTime As String

            <DataMember>
            Public Overridable Property ConfirmationNbr As String

            <DataMember>
            Public Overridable Property CarVendorCode As String

            <DataMember>
            Public Overridable Property CarRateType As String

            <DataMember>
            Public Overridable Property CarRateCode As String

            <DataMember>
            Public Overridable Property CarType As String

            <DataMember>
            Public Overridable Property CarYieldManagementNbr As String

            <DataMember>
            Public Overridable Property RateAmount As String

            <DataMember>
            Public Overridable Property RateGuaranteeIndicator As String

            <DataMember>
            Public Overridable Property MilesKilometerIndicator As String

            <DataMember>
            Public Overridable Property DistanceAllowance As String

            <DataMember>
            Public Overridable Property DistanceRateAmount As String

            <DataMember>
            Public Overridable Property CurrencyCode As String

            <DataMember>
            Public Overridable Property NbrOfCars As Integer
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Coupon
            <DataMember(Order:=1)>
            Public Overridable Property CouponSequenceNbr As String

            <DataMember(Order:=2)>
            Public Overridable Property CouponBoardPoint As String

            <DataMember(Order:=3)>
            Public Overridable Property CouponOffPoint As String

            <DataMember(Order:=4)>
            Public Overridable Property Carrier As String

            <DataMember(Order:=5)>
            Public Overridable Property FlightNbr As String

            <DataMember(Order:=6)>
            Public Overridable Property FlightDate As String

            <DataMember(Order:=7)>
            Public Overridable Property FlightTime As String
        End Class

        Public Partial Class Coupons
            Inherits List(Of Coupon)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetPNRSegments
            Inherits PagingMetadata
            '''<Summary>
            '''Record locator
            '''</Summary>
            <DataMember>
            Public Overridable Property RecordLocator As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property PNRCreationDate As String

            '''<Summary>
            '''Type of segment
            '''</Summary>
            <DataMember>
            Public Overridable Property SegmentType As String()

            '''<Summary>
            '''Type of passive segment
            '''</Summary>
            <DataMember>
            Public Overridable Property PassiveSegmentType As String()
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetPNRSegmentsResponse
            Inherits CollectionResponse(Of PNRSegments)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class HostSystem
            <DataMember(Order:=1)>
            Public Overridable Property Vendor As String

            <DataMember(Order:=2)>
            Public Overridable Property VendorLocator As String
        End Class

        <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 Overridable Property Offset As String

            '''<Summary>
            '''Number of records to return (PageSize)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
            Public Overridable Property Limit As String

            '''<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 Overridable Property TotalRecords As Integer

            '''<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 Overridable Property ResponseRecords As Integer
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerName
            <DataMember(Order:=1)>
            Public Overridable Property LastName As String

            <DataMember(Order:=2)>
            Public Overridable Property FirstName As String
        End Class

        <DataContract(Name:="PNRSegments", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PNRSegments
            <DataMember(Order:=10)>
            Public Overridable Property Summary As PNRSummary

            <DataMember(Order:=20)>
            Public Overridable Property Segments As Segments
        End Class

        <DataContract(Name:="PNRSummary", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PNRSummary
            <DataMember(Order:=1)>
            Public Overridable Property RecordLocator As String

            <DataMember(Order:=2)>
            Public Overridable Property AirlineReferences As AirlineReferences

            <DataMember(Order:=3)>
            Public Overridable Property Tickets As PNRSummaryTickets
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PNRSummaryTicket
            <DataMember(Order:=1)>
            Public Overridable Property TktNumber As String

            <DataMember(Order:=2)>
            Public Overridable Property Passenger As PassengerName

            <DataMember(Order:=3)>
            Public Overridable Property Coupons As Coupons
        End Class

        Public Partial Class PNRSummaryTickets
            Inherits List(Of PNRSummaryTicket)
        End Class

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ResponseMetadata
            <DataMember(Order:=0)>
            Public Overridable Property Success As Boolean

            <DataMember(Order:=1)>
            Public Overridable Property HasCache As Boolean

            <DataMember(Order:=2)>
            Public Overridable Property HasPaging As Boolean

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CacheMetadata As CacheMetadata

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property PagingMetadata As PagingMetadata
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Seat
            <DataMember(Order:=1)>
            Public Overridable Property SeatLocation As String

            <DataMember(Order:=2)>
            Public Overridable Property SeatStatusCode As String
        End Class

        Public Partial Class SeatingData
            Inherits List(Of Seat)
        End Class

        <DataContract(Name:="Segments", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Segments
            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property AirSegments As List(Of AirSegment)

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CarSegments As List(Of CarSegment)

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property HotelSegments As List(Of HotelSegmentDepreciated)

            <DataMember(Order:=5, EmitDefaultValue:=false)>
            Public Overridable Property PassiveSegments As List(Of PassiveSegment)
        End Class
    End Namespace
End Namespace

VB.NET GetPNRSegments DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"Summary":{"RecordLocator":"String","AirlineReferences":[{"Vendor":"String","VendorLocator":"String"}],"Tickets":[{"TktNumber":"String","Passenger":{"LastName":"String","FirstName":"String"},"Coupons":[{"CouponSequenceNbr":"String","CouponBoardPoint":"String","CouponOffPoint":"String","Carrier":"String","FlightNbr":"String","FlightDate":"String","FlightTime":"String"}]}]},"Segments":{"AirSegments":[{"AirSegmentNbr":0,"SegmentStatus":"String","DepartureDate":"String","DepartureTime":"String","CarrierCode":"String","BoardPoint":"String","OffPoint":"String","FlightNbr":"String","BookingCode":"String","ArrivalTime":"String","ChangeOfDay":"String","ConnectionIndicator":"String","OperatingCarrierCode":"String","OperatingCarrierName":"String","JourneyTime":"String","NbrSeats":0,"SeatingData":[{"SeatLocation":"String","SeatStatusCode":"String"}]}],"CarSegments":[{"CarSegmentNbr":0,"SegmentStatus":"String","PickUpDate":"String","PickUpTime":"String","AirportCode":"String","CarLocationCategory":"String","DropOffDate":"String","DropOffTime":"String","ConfirmationNbr":"String","CarVendorCode":"String","CarRateType":"String","CarRateCode":"String","CarType":"String","CarYieldManagementNbr":"String","RateAmount":"String","RateGuaranteeIndicator":"String","MilesKilometerIndicator":"String","DistanceAllowance":"String","DistanceRateAmount":"String","CurrencyCode":"String","NbrOfCars":0}],"HotelSegments":[{"HotelSegmentNbr":"String","StatusCode":"String","ArrivalDate":"String","DepartureDate":"String","PropertyName":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","PropertyCityCode":"String","SegmentStatus":"String","HotelVendorCode":"String"}],"PassiveSegments":[{"SegmentStatus":"String","StartDate":"String","DepartureDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Passenger":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String"}]}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}