| GET | /PNRSegments |
|---|
namespace AgentivityAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type HostSystem() =
[<DataMember(Order=1)>]
member val Vendor:String = null with get,set
[<DataMember(Order=2)>]
member val VendorLocator:String = null with get,set
[<AllowNullLiteral>]
type AirlineReferences() =
inherit ResizeArray<HostSystem>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassengerName() =
[<DataMember(Order=1)>]
member val LastName:String = null with get,set
[<DataMember(Order=2)>]
member val FirstName:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Coupon() =
[<DataMember(Order=1)>]
member val CouponSequenceNbr:String = null with get,set
[<DataMember(Order=2)>]
member val CouponBoardPoint:String = null with get,set
[<DataMember(Order=3)>]
member val CouponOffPoint:String = null with get,set
[<DataMember(Order=4)>]
member val Carrier:String = null with get,set
[<DataMember(Order=5)>]
member val FlightNbr:String = null with get,set
[<DataMember(Order=6)>]
member val FlightDate:String = null with get,set
[<DataMember(Order=7)>]
member val FlightTime:String = null with get,set
[<AllowNullLiteral>]
type Coupons() =
inherit ResizeArray<Coupon>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PNRSummaryTicket() =
[<DataMember(Order=1)>]
member val TktNumber:String = null with get,set
[<DataMember(Order=2)>]
member val Passenger:PassengerName = null with get,set
[<DataMember(Order=3)>]
member val Coupons:Coupons = null with get,set
[<AllowNullLiteral>]
type PNRSummaryTickets() =
inherit ResizeArray<PNRSummaryTicket>()
[<DataContract(Name="PNRSummary", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PNRSummary() =
[<DataMember(Order=1)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=2)>]
member val AirlineReferences:AirlineReferences = null with get,set
[<DataMember(Order=3)>]
member val Tickets:PNRSummaryTickets = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Seat() =
[<DataMember(Order=1)>]
member val SeatLocation:String = null with get,set
[<DataMember(Order=2)>]
member val SeatStatusCode:String = null with get,set
[<AllowNullLiteral>]
type SeatingData() =
inherit ResizeArray<Seat>()
[<DataContract(Name="AirSegment", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AirSegment() =
[<DataMember>]
member val AirSegmentNbr:Int32 = new Int32() with get,set
[<DataMember>]
member val SegmentStatus:String = null with get,set
[<DataMember>]
member val DepartureDate:String = null with get,set
[<DataMember>]
member val DepartureTime:String = null with get,set
[<DataMember>]
member val CarrierCode:String = null with get,set
[<DataMember>]
member val BoardPoint:String = null with get,set
[<DataMember>]
member val OffPoint:String = null with get,set
[<DataMember>]
member val FlightNbr:String = null with get,set
[<DataMember>]
member val BookingCode:String = null with get,set
[<DataMember>]
member val ArrivalTime:String = null with get,set
[<DataMember>]
member val ChangeOfDay:String = null with get,set
[<DataMember>]
member val ConnectionIndicator:String = null with get,set
[<DataMember>]
member val OperatingCarrierCode:String = null with get,set
[<DataMember>]
member val OperatingCarrierName:String = null with get,set
[<DataMember>]
member val JourneyTime:String = null with get,set
[<DataMember>]
member val NbrSeats:Int32 = new Int32() with get,set
[<DataMember(EmitDefaultValue=false)>]
member val SeatingData:SeatingData = null with get,set
[<DataContract(Name="CarSegment", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CarSegment() =
[<DataMember>]
member val CarSegmentNbr:Int32 = new Int32() with get,set
[<DataMember>]
member val SegmentStatus:String = null with get,set
[<DataMember>]
member val PickUpDate:String = null with get,set
[<DataMember>]
member val PickUpTime:String = null with get,set
[<DataMember>]
member val AirportCode:String = null with get,set
[<DataMember>]
member val CarLocationCategory:String = null with get,set
[<DataMember>]
member val DropOffDate:String = null with get,set
[<DataMember>]
member val DropOffTime:String = null with get,set
[<DataMember>]
member val ConfirmationNbr:String = null with get,set
[<DataMember>]
member val CarVendorCode:String = null with get,set
[<DataMember>]
member val CarRateType:String = null with get,set
[<DataMember>]
member val CarRateCode:String = null with get,set
[<DataMember>]
member val CarType:String = null with get,set
[<DataMember>]
member val CarYieldManagementNbr:String = null with get,set
[<DataMember>]
member val RateAmount:String = null with get,set
[<DataMember>]
member val RateGuaranteeIndicator:String = null with get,set
[<DataMember>]
member val MilesKilometerIndicator:String = null with get,set
[<DataMember>]
member val DistanceAllowance:String = null with get,set
[<DataMember>]
member val DistanceRateAmount:String = null with get,set
[<DataMember>]
member val CurrencyCode:String = null with get,set
[<DataMember>]
member val NbrOfCars:Int32 = new Int32() with get,set
[<DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type HotelSegmentDepreciated() =
[<DataMember(Order=1)>]
member val HotelSegmentNbr:String = null with get,set
[<DataMember(Order=4)>]
member val StatusCode:String = null with get,set
[<DataMember(Order=5)>]
member val ArrivalDate:String = null with get,set
[<DataMember(Order=6)>]
member val DepartureDate:String = null with get,set
[<DataMember(Order=7)>]
member val PropertyName:String = null with get,set
[<DataMember(Order=16)>]
member val ConfirmationNbr:String = null with get,set
[<DataMember(Order=17)>]
member val Currency:String = null with get,set
[<DataMember(Order=18)>]
member val Rate:String = null with get,set
[<DataMember(Order=19)>]
member val RoomBookingCode:String = null with get,set
[<DataMember(Order=20)>]
member val NbrNights:Int32 = new Int32() with get,set
[<DataMember(Order=21)>]
member val MultiLevelRateCode:String = null with get,set
[<DataMember(Order=22)>]
member val NbrRooms:Int32 = new Int32() with get,set
[<DataMember(Order=23)>]
member val BookedInName:String = null with get,set
[<DataMember(Order=24)>]
member val ServiceInformation:String = null with get,set
[<DataMember(Order=25)>]
member val PropertyCityCode:String = null with get,set
[<DataMember(Order=26)>]
member val SegmentStatus:String = null with get,set
[<DataMember(Order=27)>]
member val HotelVendorCode:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassiveSegment() =
[<DataMember>]
member val SegmentStatus:String = null with get,set
[<DataMember>]
member val StartDate:String = null with get,set
[<DataMember>]
member val DepartureDate:String = null with get,set
[<DataMember>]
member val NbrNights:String = null with get,set
[<DataMember>]
member val VendorCode:String = null with get,set
[<DataMember>]
member val CityCode:String = null with get,set
[<DataMember>]
member val SegmentType:String = null with get,set
[<DataMember>]
member val Text:String = null with get,set
[<DataMember>]
member val Passenger:String = null with get,set
[<DataMember>]
member val Address:String = null with get,set
[<DataMember>]
member val BookingReasonCode:String = null with get,set
[<DataMember>]
member val BookingSource:String = null with get,set
[<DataMember>]
member val CommissionInformation:String = null with get,set
[<DataMember>]
member val ConfirmationNumber:String = null with get,set
[<DataMember>]
member val RateCode:String = null with get,set
[<DataMember>]
member val RateQuoted:String = null with get,set
[<DataMember>]
member val RateAccessCode:String = null with get,set
[<DataMember>]
member val PropertyName:String = null with get,set
[<DataMember>]
member val PropertyNumber:String = null with get,set
[<DataMember>]
member val ServiceInformation:String = null with get,set
[<DataContract(Name="Segments", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Segments() =
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val AirSegments:ResizeArray<AirSegment> = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CarSegments:ResizeArray<CarSegment> = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val HotelSegments:ResizeArray<HotelSegmentDepreciated> = null with get,set
[<DataMember(Order=5, EmitDefaultValue=false)>]
member val PassiveSegments:ResizeArray<PassiveSegment> = null with get,set
[<DataContract(Name="PNRSegments", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PNRSegments() =
[<DataMember(Order=10)>]
member val Summary:PNRSummary = null with get,set
[<DataMember(Order=20)>]
member val Segments:Segments = null with get,set
[<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CacheMetadata() =
[<DataMember(Order=1)>]
member val CachedAt:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
member val CacheExpiresAt:DateTime = new DateTime() with get,set
[<DataMember(Order=0)>]
member val IsFromCache:Boolean = new Boolean() with get,set
[<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PagingMetadata() =
///<summary>
///Starting Record
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
member val Offset:String = null with 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")>]
member val Limit:String = null with 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")>]
member val TotalRecords:Int32 = new Int32() with 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")>]
member val ResponseRecords:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ResponseMetadata() =
[<DataMember(Order=0)>]
member val Success:Boolean = new Boolean() with get,set
[<DataMember(Order=1)>]
member val HasCache:Boolean = new Boolean() with get,set
[<DataMember(Order=2)>]
member val HasPaging:Boolean = new Boolean() with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CacheMetadata:CacheMetadata = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val PagingMetadata:PagingMetadata = null with get,set
[<DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ApiRequestPerHour() =
[<DataMember(Order=10)>]
member val RequestDate:DateTime = new DateTime() with get,set
[<DataMember(Order=100)>]
member val Hour0:Int32 = new Int32() with get,set
[<DataMember(Order=110)>]
member val Hour1:Int32 = new Int32() with get,set
[<DataMember(Order=120)>]
member val Hour2:Int32 = new Int32() with get,set
[<DataMember(Order=130)>]
member val Hour3:Int32 = new Int32() with get,set
[<DataMember(Order=140)>]
member val Hour4:Int32 = new Int32() with get,set
[<DataMember(Order=150)>]
member val Hour5:Int32 = new Int32() with get,set
[<DataMember(Order=160)>]
member val Hour6:Int32 = new Int32() with get,set
[<DataMember(Order=170)>]
member val Hour7:Int32 = new Int32() with get,set
[<DataMember(Order=180)>]
member val Hour8:Int32 = new Int32() with get,set
[<DataMember(Order=190)>]
member val Hour9:Int32 = new Int32() with get,set
[<DataMember(Order=200)>]
member val Hour10:Int32 = new Int32() with get,set
[<DataMember(Order=210)>]
member val Hour11:Int32 = new Int32() with get,set
[<DataMember(Order=220)>]
member val Hour12:Int32 = new Int32() with get,set
[<DataMember(Order=230)>]
member val Hour13:Int32 = new Int32() with get,set
[<DataMember(Order=240)>]
member val Hour14:Int32 = new Int32() with get,set
[<DataMember(Order=250)>]
member val Hour15:Int32 = new Int32() with get,set
[<DataMember(Order=260)>]
member val Hour16:Int32 = new Int32() with get,set
[<DataMember(Order=270)>]
member val Hour17:Int32 = new Int32() with get,set
[<DataMember(Order=280)>]
member val Hour18:Int32 = new Int32() with get,set
[<DataMember(Order=290)>]
member val Hour19:Int32 = new Int32() with get,set
[<DataMember(Order=300)>]
member val Hour20:Int32 = new Int32() with get,set
[<DataMember(Order=310)>]
member val Hour21:Int32 = new Int32() with get,set
[<DataMember(Order=320)>]
member val Hour22:Int32 = new Int32() with get,set
[<DataMember(Order=330)>]
member val Hour23:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgentivityError() =
[<DataMember>]
member val ErrorCode:String = null with get,set
[<DataMember>]
member val Message:String = null with get,set
[<DataMember>]
member val StatusCode:String = null with get,set
[<DataMember>]
member val VerboseMessage:String = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CollectionResponse<TItem>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:ResizeArray<ApiRequestPerHour> = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val ResponseError:AgentivityError = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetPNRSegmentsResponse() =
inherit CollectionResponse<PNRSegments>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetPNRSegments() =
inherit PagingMetadata()
///<summary>
///Record locator
///</summary>
[<DataMember>]
member val RecordLocator:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val PNRCreationDate:String = null with get,set
///<summary>
///Type of segment
///</summary>
[<DataMember>]
member val SegmentType:String[] = null with get,set
///<summary>
///Type of passive segment
///</summary>
[<DataMember>]
member val PassiveSegmentType:String[] = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: servicestack.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>