Agentivity API

<back to all web services

GetPassengerLocationsByAirport

The following routes are available for this service:
All Verbs/PassengerLocationsByAirport
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetPassengerLocationsByAirport : CompanyLevelRequestBase(), IRepeatByPassenger
{
    /**
    * Airport code
    */
    @DataMember
    open var AirportCode:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DateEnd:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var DateStart:String? = null

    /**
    * Include passengers that are in transit only in response
    */
    @DataMember
    open var InTransitOnly:Boolean? = null

    /**
    * Comma Delimited List of Accounts
    */
    @DataMember
    open var Account:ArrayList<String>? = null

    /**
    * Comma Delimited List of Custom Fields
    */
    @DataMember
    open var CustomField:ArrayList<String>? = null

    /**
    * Option to place passenger names on separate lines in the downloadable result (spreadsheet)
    */
    @DataMember
    override var RepeatByPassenger:Boolean? = 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 PassengerLocationsByAirportItemResponse : ItemResponse<PassengerLocation, PassengerLocationsByAirportResponseReport>()
{
}

@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="Segment", Namespace="schemas.agentivity.com/types")
open class PassengerLocation : IBookingItinerary, IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IPassengerInfo
{
    @DataMember(Order=1)
    override var RecordLocator:String? = null

    @DataMember(Order=2)
    open var TravelDate:Date? = null

    @DataMember(Order=3)
    open var DepartureDate:Date? = null

    @DataMember(Order=4)
    open var BoardPoint:String? = null

    @DataMember(Order=5)
    open var OffPoint:String? = null

    @DataMember(Order=6)
    open var PnrTicketed:String? = null

    @DataMember(Order=7)
    open var Account:String? = null

    @DataMember(Order=8)
    open var Consultant:String? = null

    @DataMember(Order=9)
    open var PaxList:String? = null

    @DataMember(Order=10)
    open var PhoneNbr:String? = null

    @DataMember(Order=11)
    open var EmailAddress:String? = null

    @DataMember(Order=12)
    open var DestinationCities:String? = null

    @DataMember(Order=13)
    open var Connections:String? = null

    @DataMember(Order=14)
    open var CarrierCodes:String? = null

    @DataMember(Order=16)
    open var HotelsNames:String? = null

    @DataMember(Order=30)
    open var FlightNumbers:String? = null

    @DataMember(Order=40)
    open var OwningAgencyLocationID:String? = null

    @DataMember(Order=50)
    open var IataCodes:String? = null

    @DataMember(Order=15)
    override var AgentivityRef:Int? = null

    @DataMember(Order=120)
    override var Itinerary:ItinerarySegmentsCollection? = null

    @DataMember(Order=130)
    override var ItineraryFormatted:String? = null

    @DataMember(Order=140)
    override var CustomFields:CustomFieldsCollection? = null

    @DataMember(Order=150)
    open var DepartureDateTime:Date? = null

    @DataMember(Order=160)
    open var CurrentArrivalDateTime:Date? = null

    @DataMember(Order=170)
    open var SegmentType:String? = null

    @DataMember(Order=180)
    open var AirSegmentNbr:String? = null

    @DataMember(Order=190)
    override var PNRCreationDate:Date? = null

    @DataMember(Order=200)
    override var TicketNumbers:ArrayList<String>? = null

    @DataMember(Order=210)
    override var VendorLocators:ArrayList<BookingExtVendorLocator>? = null

    @DataMember(Order=220)
    override var PassengerInfo:ArrayList<BookingPassengerModel>? = null
}

open class ItinerarySegmentsCollection : ArrayList<ItinerarySegment>()
{
}

@DataContract(Name="ItinerarySegment", Namespace="schemas.agentivity.com/types")
open class ItinerarySegment
{
    @DataMember
    open var SegmentType:String? = null

    @DataMember
    open var SegmentNbr:Int? = null

    @DataMember
    open var BoardPoint:String? = null

    @DataMember
    open var OffPoint:String? = null

    @DataMember
    open var OperatorCode:String? = null

    @DataMember
    open var OperatorService:String? = null

    @DataMember
    open var SegmentStatus:String? = null

    @DataMember
    open var DepartureTimeFormatted:String? = null

    @DataMember
    open var ArrivalTimeFormatted:String? = null

    @DataMember
    open var ChangeOfDayFormatted:String? = null

    @DataMember
    open var ServiceCode:String? = null

    @DataMember
    open var StartDate:String? = null

    @DataMember
    open var EndDate:String? = null

    @DataMember
    open var TicketNumber:String? = null

    /**
    * Comma separated list of vendor locators
    */
    @DataMember
    open var VendorLocators:String? = null

    @DataMember
    open var EquipmentCode:String? = null

    @DataMember
    open var Equipment:String? = 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="Passenger", Namespace="schemas.agentivity.com/types")
open class BookingPassengerModel
{
    @DataMember(Order=10)
    open var FirstName:String? = null

    @DataMember(Order=20)
    open var LastName:String? = null

    @DataMember(Order=30)
    open var PassengerDataId:Int? = null
}

@DataContract(Name="PassengerLocation", Namespace="schemas.agentivity.com/types")
open class PassengerLocationsByAirportResponseReport : Report<PassengerLocationsByAirportItemResponse, PassengerLocation>()
{
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin GetPassengerLocationsByAirport DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + 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"}}