| All Verbs | /PassengerLocationsByAirport |
|---|
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(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Report<TItemResponse, TItem>() =
[<DataMember(Order=1, EmitDefaultValue=false)>]
member val Item:TItem = null with get,set
[<DataContract(Name="PassengerLocation", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassengerLocationsByAirportResponseReport() =
inherit Report<PassengerLocationsByAirportItemResponse, PassengerLocation>()
[<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="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 ItemResponse<TItem, TReport>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:TReport = 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 PassengerLocationsByAirportItemResponse() =
inherit ItemResponse<PassengerLocation, PassengerLocationsByAirportResponseReport>()
[<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 GetPassengerLocationsByAirport() =
inherit CompanyLevelRequestBase()
///<summary>
///Airport code
///</summary>
[<DataMember>]
member val AirportCode:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DateEnd:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DateStart:String = null with get,set
///<summary>
///Include passengers that are in transit only in response
///</summary>
[<DataMember>]
member val InTransitOnly:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Comma Delimited List of Accounts
///</summary>
[<DataMember>]
member val Account:String[] = null with get,set
///<summary>
///Comma Delimited List of Custom Fields
///</summary>
[<DataMember>]
member val CustomField:String[] = null with get,set
///<summary>
///Option to place passenger names on separate lines in the downloadable result (spreadsheet)
///</summary>
[<DataMember>]
member val RepeatByPassenger:Boolean = new Boolean() with get,set
F# GetPassengerLocationsByAirport DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PassengerLocationsByAirport HTTP/1.1
Host: api.agentivity.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"AirportCode":"String","DateEnd":"String","DateStart":"String","InTransitOnly":false,"Account":["String"],"CustomField":["String"],"RepeatByPassenger":false,"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{"Item":{"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"}]}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}