| GET | /PassengerLocationsByFlightNumber |
|---|
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="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="PassengerLocationFlightNumber", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassengerLocationFlightNumber() =
[<DataMember(Order=10)>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=30)>]
member val PaxList:String = null with get,set
[<DataMember(Order=40)>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=50)>]
member val Account:String = null with get,set
[<DataMember(Order=60)>]
member val DepartureDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=70)>]
member val BoardPoint:String = null with get,set
[<DataMember(Order=80)>]
member val OffPoint:String = null with get,set
[<DataMember(Order=90)>]
member val DepartureTime:String = null with get,set
[<DataMember(Order=100)>]
member val ArrivalTime:String = null with get,set
[<DataMember(Order=110)>]
member val ChangeOfDay:String = null with get,set
[<DataMember(Order=120)>]
member val EmailAddress:String = null with get,set
[<DataMember(Order=130)>]
member val PhoneNbr:String = null with get,set
[<DataMember(Order=140)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=150)>]
member val IataCodes:String = null with get,set
[<DataMember(Order=160)>]
member val CustomFields:CustomFieldsCollection = null with get,set
[<DataMember(Order=170)>]
member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=180)>]
member val TicketNumbers:String[] = null with get,set
[<DataMember(Order=190)>]
member val VendorLocators:BookingExtVendorLocator[] = 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="PassengerLocationFlightNumber", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassengerLocationsByFlightNumberResponseReport() =
inherit Report<PassengerLocationsByFlightNumberItemResponse, PassengerLocationFlightNumber>()
[<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 PassengerLocationsByFlightNumberItemResponse() =
inherit ItemResponse<PassengerLocationFlightNumber, PassengerLocationsByFlightNumberResponseReport>()
[<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 GetPassengerLocationsByFlightNumber() =
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 DepartureDateStart:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DepartureDateEnd:String = null with get,set
///<summary>
///Two letter code for carrier
///</summary>
[<DataMember>]
member val CarrierCode:String = null with get,set
///<summary>
///Flight number without spaces
///</summary>
[<DataMember>]
member val FlightNumber:String = null with get,set
///<summary>
///All future date
///</summary>
[<DataMember>]
member val AllFutureDate:Boolean = new Boolean() with get,set
///<summary>
///Comma Delimited List of Custom Fields
///</summary>
[<DataMember>]
member val CustomField:String[] = null with get,set
F# GetPassengerLocationsByFlightNumber DTOs
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 /PassengerLocationsByFlightNumber 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>
<Item>
<AgentivityRef>0</AgentivityRef>
<RecordLocator>String</RecordLocator>
<PaxList>String</PaxList>
<OwningConsultantID>String</OwningConsultantID>
<Account>String</Account>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<DepartureTime>String</DepartureTime>
<ArrivalTime>String</ArrivalTime>
<ChangeOfDay>String</ChangeOfDay>
<EmailAddress>String</EmailAddress>
<PhoneNbr>String</PhoneNbr>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<IataCodes>String</IataCodes>
<CustomFields>
<CustomField>
<FieldName>String</FieldName>
<FieldValue>String</FieldValue>
</CustomField>
</CustomFields>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</TicketNumbers>
<VendorLocators>
<VendorLocator>
<CarrierCode>String</CarrierCode>
<VendorLocator>String</VendorLocator>
</VendorLocator>
</VendorLocators>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>