Agentivity API

<back to all web services

GetPassengerLocationsByRouting

The following routes are available for this service:
GET/PassengerLocationsByRouting
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(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ItinerarySegment() = 
        [<DataMember>]
        member val SegmentType:String = null with get,set

        [<DataMember>]
        member val SegmentNbr:Int32 = new Int32() with get,set

        [<DataMember>]
        member val BoardPoint:String = null with get,set

        [<DataMember>]
        member val OffPoint:String = null with get,set

        [<DataMember>]
        member val OperatorCode:String = null with get,set

        [<DataMember>]
        member val OperatorService:String = null with get,set

        [<DataMember>]
        member val SegmentStatus:String = null with get,set

        [<DataMember>]
        member val DepartureTimeFormatted:String = null with get,set

        [<DataMember>]
        member val ArrivalTimeFormatted:String = null with get,set

        [<DataMember>]
        member val ChangeOfDayFormatted:String = null with get,set

        [<DataMember>]
        member val ServiceCode:String = null with get,set

        [<DataMember>]
        member val StartDate:String = null with get,set

        [<DataMember>]
        member val EndDate:String = null with get,set

        [<DataMember>]
        member val TicketNumber:String = null with get,set

        ///<summary>
        ///Comma separated list of vendor locators
        ///</summary>
        [<DataMember>]
        member val VendorLocators:String = null with get,set

        [<DataMember>]
        member val EquipmentCode:String = null with get,set

        [<DataMember>]
        member val Equipment:String = null with get,set

    [<AllowNullLiteral>]
    type ItinerarySegmentsCollection() = 
        inherit ResizeArray<ItinerarySegment>()

    [<DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CustomFieldData() = 
        [<DataMember(Order=20)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=30)>]
        member val FieldValue:String = null with get,set

    [<AllowNullLiteral>]
    type CustomFieldsCollection() = 
        inherit ResizeArray<CustomFieldData>()

    [<DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type BookingExtVendorLocator() = 
        [<DataMember(Order=10)>]
        member val CarrierCode:String = null with get,set

        [<DataMember(Order=20)>]
        member val VendorLocator:String = null with get,set

    [<DataContract(Name="Passenger", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type BookingPassengerModel() = 
        [<DataMember(Order=10)>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=20)>]
        member val LastName:String = null with get,set

        [<DataMember(Order=30)>]
        member val PassengerDataId:Int32 = new Int32() with get,set

    [<DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type PassengerLocation() = 
        [<DataMember(Order=1)>]
        member val RecordLocator:String = null with get,set

        [<DataMember(Order=2)>]
        member val TravelDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=3)>]
        member val DepartureDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=4)>]
        member val BoardPoint:String = null with get,set

        [<DataMember(Order=5)>]
        member val OffPoint:String = null with get,set

        [<DataMember(Order=6)>]
        member val PnrTicketed:String = null with get,set

        [<DataMember(Order=7)>]
        member val Account:String = null with get,set

        [<DataMember(Order=8)>]
        member val Consultant:String = null with get,set

        [<DataMember(Order=9)>]
        member val PaxList:String = null with get,set

        [<DataMember(Order=10)>]
        member val PhoneNbr:String = null with get,set

        [<DataMember(Order=11)>]
        member val EmailAddress:String = null with get,set

        [<DataMember(Order=12)>]
        member val DestinationCities:String = null with get,set

        [<DataMember(Order=13)>]
        member val Connections:String = null with get,set

        [<DataMember(Order=14)>]
        member val CarrierCodes:String = null with get,set

        [<DataMember(Order=16)>]
        member val HotelsNames:String = null with get,set

        [<DataMember(Order=30)>]
        member val FlightNumbers:String = null with get,set

        [<DataMember(Order=40)>]
        member val OwningAgencyLocationID:String = null with get,set

        [<DataMember(Order=50)>]
        member val IataCodes:String = null with get,set

        [<DataMember(Order=15)>]
        member val AgentivityRef:Int32 = new Int32() with get,set

        [<DataMember(Order=120)>]
        member val Itinerary:ItinerarySegmentsCollection = null with get,set

        [<DataMember(Order=130)>]
        member val ItineraryFormatted:String = null with get,set

        [<DataMember(Order=140)>]
        member val CustomFields:CustomFieldsCollection = null with get,set

        [<DataMember(Order=150)>]
        member val DepartureDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=160)>]
        member val CurrentArrivalDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=170)>]
        member val SegmentType:String = null with get,set

        [<DataMember(Order=180)>]
        member val AirSegmentNbr:String = null with get,set

        [<DataMember(Order=190)>]
        member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=200)>]
        member val TicketNumbers:String[] = null with get,set

        [<DataMember(Order=210)>]
        member val VendorLocators:BookingExtVendorLocator[] = null with get,set

        [<DataMember(Order=220)>]
        member val PassengerInfo:BookingPassengerModel[] = null with get,set

    [<DataContract(Name="Segment", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type PassengerLocationRouting() = 
        inherit PassengerLocation()
        [<DataMember(Order=1000)>]
        member val DestinationCountries:String = 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 PassengerLocationsByRoutingResponse() = 
        inherit CollectionResponse<PassengerLocationRouting>()

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CompanyLevelRequestBase() = 
        inherit PagingMetadata()
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [<DataMember>]
        member val OwningCompanyCode:String[] = null with get,set

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [<DataMember>]
        member val UserName:String = null with get,set

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type GetPassengerLocationsByRouting() = 
        inherit CompanyLevelRequestBase()
        ///<summary>
        ///Comma Delimited List of Accounts
        ///</summary>
        [<DataMember>]
        member val Account:String[] = null with get,set

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val DateStart:String = null with get,set

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val DateEnd:String = null with get,set

        ///<summary>
        ///From Airport Code
        ///</summary>
        [<DataMember>]
        member val FromAirportCode:String = null with get,set

        ///<summary>
        ///From City Code
        ///</summary>
        [<DataMember>]
        member val FromCityCode:String = null with get,set

        ///<summary>
        ///From Country Code
        ///</summary>
        [<DataMember>]
        member val FromCountryCode:String = null with get,set

        ///<summary>
        ///From Subregion Code
        ///</summary>
        [<DataMember>]
        member val FromSubregionCode:String = null with get,set

        ///<summary>
        ///From Region Code
        ///</summary>
        [<DataMember>]
        member val FromRegionCode:String = null with get,set

        ///<summary>
        ///To Airport Code
        ///</summary>
        [<DataMember>]
        member val ToAirportCode:String = null with get,set

        ///<summary>
        ///To City Code
        ///</summary>
        [<DataMember>]
        member val ToCityCode:String = null with get,set

        ///<summary>
        ///To Country Code
        ///</summary>
        [<DataMember>]
        member val ToCountryCode:String = null with get,set

        ///<summary>
        ///To Subregion Code
        ///</summary>
        [<DataMember>]
        member val ToSubregionCode:String = null with get,set

        ///<summary>
        ///To Region Code
        ///</summary>
        [<DataMember>]
        member val ToRegionCode:String = null with get,set

        ///<summary>
        ///Comma delimited list of owning consultants ids
        ///</summary>
        [<DataMember>]
        member val OwningConsultantID:String[] = null with get,set

        ///<summary>
        ///Comma Delimited List of Custom Fields
        ///</summary>
        [<DataMember>]
        member val CustomField:String[] = null with get,set

        ///<summary>
        ///Request Consultant ID (sign on)
        ///</summary>
        [<DataMember>]
        member val RequestConsultantID:String = null with get,set

F# GetPassengerLocationsByRouting 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 /PassengerLocationsByRouting 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":[{"RecordLocator":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","PnrTicketed":"String","Account":"String","Consultant":"String","PaxList":"String","PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","AgentivityRef":0,"HotelsNames":"String","FlightNumbers":"String","OwningAgencyLocationID":"String","IataCodes":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","CurrentArrivalDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","AirSegmentNbr":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}],"PassengerInfo":[{"FirstName":"String","LastName":"String","PassengerDataId":0,"Tickets":[{"Number":"String","Type":"String"}]}],"DestinationCountries":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}