| GET | /PassengerLocationsByFlightNumber |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class GetPassengerLocationsByFlightNumber : CompanyLevelRequestBase()
{
/**
* Comma Delimited List of Accounts
*/
@DataMember
open var Account:ArrayList<String>? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DepartureDateStart:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var DepartureDateEnd:String? = null
/**
* Two letter code for carrier
*/
@DataMember
open var CarrierCode:String? = null
/**
* Flight number without spaces
*/
@DataMember
open var FlightNumber:String? = null
/**
* All future date
*/
@DataMember
open var AllFutureDate:Boolean? = null
/**
* Comma Delimited List of Custom Fields
*/
@DataMember
open var CustomField:ArrayList<String>? = null
}
@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
@DataMember
override var OwningCompanyCode:ArrayList<String>? = null
/**
* UserName in form of an email address
*/
@DataMember
override var UserName:String? = null
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
open var Offset:String? = null
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
open var Limit:String? = null
/**
* Total Number of Records in a Full Reponse (if no paging)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
open var TotalRecords:Int? = null
/**
* Total Number of Records in this Reponse (on this page)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
open var ResponseRecords:Int? = null
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class PassengerLocationsByFlightNumberItemResponse : ItemResponse<PassengerLocationFlightNumber, PassengerLocationsByFlightNumberResponseReport>()
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
@DataMember(Order=1)
open var ResponseMetadata:ResponseMetadata? = null
@DataMember(Order=2, EmitDefaultValue=false)
open var ResponseReport:TReport? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var ResponseError:AgentivityError? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
@DataMember(Order=0)
open var Success:Boolean? = null
@DataMember(Order=1)
open var HasCache:Boolean? = null
@DataMember(Order=2)
open var HasPaging:Boolean? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var CacheMetadata:CacheMetadata? = null
@DataMember(Order=4, EmitDefaultValue=false)
open var PagingMetadata:PagingMetadata? = null
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
@DataMember(Order=1)
open var CachedAt:Date? = null
@DataMember(Order=2)
open var CacheExpiresAt:Date? = null
@DataMember(Order=0)
open var IsFromCache:Boolean? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
@DataMember
open var ErrorCode:String? = null
@DataMember
open var Message:String? = null
@DataMember
open var StatusCode:String? = null
@DataMember
open var VerboseMessage:String? = null
}
@DataContract(Name="PassengerLocationFlightNumber", Namespace="schemas.agentivity.com/types")
open class PassengerLocationFlightNumber : IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators
{
@DataMember(Order=10)
override var AgentivityRef:Int? = null
@DataMember(Order=20)
override var RecordLocator:String? = null
@DataMember(Order=30)
open var PaxList:String? = null
@DataMember(Order=40)
open var OwningConsultantID:String? = null
@DataMember(Order=50)
open var Account:String? = null
@DataMember(Order=60)
open var DepartureDate:Date? = null
@DataMember(Order=70)
open var BoardPoint:String? = null
@DataMember(Order=80)
open var OffPoint:String? = null
@DataMember(Order=90)
open var DepartureTime:String? = null
@DataMember(Order=100)
open var ArrivalTime:String? = null
@DataMember(Order=110)
open var ChangeOfDay:String? = null
@DataMember(Order=120)
open var EmailAddress:String? = null
@DataMember(Order=130)
open var PhoneNbr:String? = null
@DataMember(Order=140)
open var OwningAgencyLocationID:String? = null
@DataMember(Order=150)
open var IataCodes:String? = null
@DataMember(Order=160)
override var CustomFields:CustomFieldsCollection? = null
@DataMember(Order=170)
override var PNRCreationDate:Date? = null
@DataMember(Order=180)
override var TicketNumbers:ArrayList<String>? = null
@DataMember(Order=190)
override var VendorLocators:ArrayList<BookingExtVendorLocator>? = null
}
open class CustomFieldsCollection : ArrayList<CustomFieldData>()
{
}
@DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
open class CustomFieldData
{
@DataMember(Order=20)
open var FieldName:String? = null
@DataMember(Order=30)
open var FieldValue:String? = null
}
@DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
open class BookingExtVendorLocator : IBookingIdentifier
{
@DataMember(Order=10)
open var CarrierCode:String? = null
@DataMember(Order=20)
open var VendorLocator:String? = null
}
@DataContract(Name="PassengerLocationFlightNumber", Namespace="schemas.agentivity.com/types")
open class PassengerLocationsByFlightNumberResponseReport : Report<PassengerLocationsByFlightNumberItemResponse, PassengerLocationFlightNumber>()
{
}
@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
@DataMember(Order=1, EmitDefaultValue=false)
open var Item:TItem? = null
}
Kotlin GetPassengerLocationsByFlightNumber 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.
GET /PassengerLocationsByFlightNumber HTTP/1.1 Host: api.agentivity.com Accept: text/jsonl
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":{"AgentivityRef":0,"RecordLocator":"String","PaxList":"String","OwningConsultantID":"String","Account":"String","DepartureDate":"\/Date(-62135596800000-0000)\/","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","ArrivalTime":"String","ChangeOfDay":"String","EmailAddress":"String","PhoneNbr":"String","OwningAgencyLocationID":"String","IataCodes":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}