| GET | /PassengerLocationsByCountry |
|---|
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="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 PassengerLocationsByCountryResponse() =
inherit CollectionResponse<PassengerLocation>()
[<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
[<Flags>]
type FormattingStyle =
| None = 0
| Html = 1
| Charting = 2
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetPassengerLocationsByCountry() =
inherit CompanyLevelRequestBase()
///<summary>
///2 letter country code
///</summary>
[<DataMember>]
member val CountryCode: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
[<DataMember>]
member val modifier:String = null with get,set
[<DataMember>]
member val IncludeItinerary:Boolean = new Boolean() with get,set
[<DataMember>]
member val ItineraryFormatting:FormattingStyle = new FormattingStyle() 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# GetPassengerLocationsByCountry 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 /PassengerLocationsByCountry 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>
<Segment>
<RecordLocator>String</RecordLocator>
<TravelDate>0001-01-01T00:00:00</TravelDate>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<PnrTicketed>String</PnrTicketed>
<Account>String</Account>
<Consultant>String</Consultant>
<PaxList>String</PaxList>
<PhoneNbr>String</PhoneNbr>
<EmailAddress>String</EmailAddress>
<DestinationCities>String</DestinationCities>
<Connections>String</Connections>
<CarrierCodes>String</CarrierCodes>
<AgentivityRef>0</AgentivityRef>
<HotelsNames>String</HotelsNames>
<FlightNumbers>String</FlightNumbers>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<IataCodes>String</IataCodes>
<Itinerary>
<ItinerarySegment>
<ArrivalTimeFormatted>String</ArrivalTimeFormatted>
<BoardPoint>String</BoardPoint>
<ChangeOfDayFormatted>String</ChangeOfDayFormatted>
<DepartureTimeFormatted>String</DepartureTimeFormatted>
<EndDate>String</EndDate>
<Equipment>String</Equipment>
<EquipmentCode>String</EquipmentCode>
<OffPoint>String</OffPoint>
<OperatorCode>String</OperatorCode>
<OperatorService>String</OperatorService>
<SegmentNbr>0</SegmentNbr>
<SegmentStatus>String</SegmentStatus>
<SegmentType>String</SegmentType>
<ServiceCode>String</ServiceCode>
<StartDate>String</StartDate>
<TicketNumber>String</TicketNumber>
<VendorLocators>String</VendorLocators>
</ItinerarySegment>
</Itinerary>
<ItineraryFormatted>String</ItineraryFormatted>
<CustomFields>
<CustomField>
<FieldName>String</FieldName>
<FieldValue>String</FieldValue>
</CustomField>
</CustomFields>
<DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
<CurrentArrivalDateTime>0001-01-01T00:00:00</CurrentArrivalDateTime>
<SegmentType>String</SegmentType>
<AirSegmentNbr>String</AirSegmentNbr>
<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>
<PassengerInfo>
<Passenger>
<FirstName>String</FirstName>
<LastName>String</LastName>
<PassengerDataId>0</PassengerDataId>
<Tickets>
<Ticket>
<Number>String</Number>
<Type>String</Type>
</Ticket>
</Tickets>
</Passenger>
</PassengerInfo>
</Segment>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>