Agentivity API

<back to all web services

GetPassengerLocationsByAirline

The following routes are available for this service:
GET/PassengerLocationsByAirlineCityDepreciated, do not use
GET/PassengerLocationsByAirline
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel.Base
Imports AgentivityAPI.ServiceModel
Imports AgentivityAPI.ServiceModel.ExtendedModels

Namespace Global

    Namespace AgentivityAPI.ServiceModel

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItemResponse(Of TItem, TReport)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property ResponseReport As TReport

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Report(Of TItemResponse, TItem)
            <DataMember(Order:=1, EmitDefaultValue:=false)>
            Public Overridable Property Item As TItem
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Base

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CompanyLevelRequestBase
            Inherits PagingMetadata
            Implements IMemberUsername
            Implements IMemberOwningCompanyCode
            '''<Summary>
            '''Comma Delimited List of Owning Company Codes
            '''</Summary>
            <DataMember>
            Public Overridable Property OwningCompanyCode As String() Implements IMemberOwningCompanyCode.OwningCompanyCode

            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String Implements IMemberUsername.UserName
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.ExtendedModels

        <DataContract(Name:="VendorLocator", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class BookingExtVendorLocator
            Implements IBookingIdentifier
            <DataMember(Order:=10)>
            Public Overridable Property CarrierCode As String

            <DataMember(Order:=20)>
            Public Overridable Property VendorLocator As String
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Types

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AgentivityError
            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property StatusCode As String

            <DataMember>
            Public Overridable Property VerboseMessage As String
        End Class

        <DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CacheMetadata
            <DataMember(Order:=1)>
            Public Overridable Property CachedAt As Date

            <DataMember(Order:=2)>
            Public Overridable Property CacheExpiresAt As Date

            <DataMember(Order:=0)>
            Public Overridable Property IsFromCache As Boolean
        End Class

        <DataContract(Name:="CustomField", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CustomFieldData
            <DataMember(Order:=20)>
            Public Overridable Property FieldName As String

            <DataMember(Order:=30)>
            Public Overridable Property FieldValue As String
        End Class

        Public Partial Class CustomFieldsCollection
            Inherits List(Of CustomFieldData)
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetPassengerLocationsByAirline
            Inherits CompanyLevelRequestBase
            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String()

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property DateStart As String

            '''<Summary>
            '''Date in format YYYYMMDD
            '''</Summary>
            <DataMember>
            Public Overridable Property DateEnd As String

            '''<Summary>
            '''Two letter code for carrier
            '''</Summary>
            <DataMember>
            Public Overridable Property CarrierCode As String

            '''<Summary>
            '''3 letter city code
            '''</Summary>
            <DataMember>
            Public Overridable Property CityCode As String

            '''<Summary>
            '''Search operating vendor
            '''</Summary>
            <DataMember>
            Public Overridable Property SearchOperatingVendor As Boolean

            '''<Summary>
            '''Comma Delimited List of Custom Fields
            '''</Summary>
            <DataMember>
            Public Overridable Property CustomField As String()
        End Class

        <DataContract(Name:="Metadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PagingMetadata
            '''<Summary>
            '''Starting Record
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Starting Record", Name:="Offset", ParameterType:="query")>
            Public Overridable Property Offset As String

            '''<Summary>
            '''Number of records to return (PageSize)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
            Public Overridable Property Limit As String

            '''<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")>
            Public Overridable Property TotalRecords As Integer

            '''<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")>
            Public Overridable Property ResponseRecords As Integer
        End Class

        <DataContract(Name:="PassengerLocationAirline", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerLocationAirline
            Implements IBookingCustomFields
            Implements IBookingIdentifier
            Implements ITicketNumbers
            Implements IVendorLocators
            <DataMember(Order:=10)>
            Public Overridable Property AgentivityRef As Integer Implements IBookingIdentifier.AgentivityRef

            <DataMember(Order:=20)>
            Public Overridable Property RecordLocator As String Implements IBookingIdentifier.RecordLocator

            <DataMember(Order:=30)>
            Public Overridable Property OwningConsultantID As String

            <DataMember(Order:=40)>
            Public Overridable Property TravelDate As Date?

            <DataMember(Order:=50)>
            Public Overridable Property PnrTicketed As String

            <DataMember(Order:=60)>
            Public Overridable Property PaxList As String

            <DataMember(Order:=70)>
            Public Overridable Property Account As String

            <DataMember(Order:=80)>
            Public Overridable Property DestinationCities As String

            <DataMember(Order:=90)>
            Public Overridable Property Connections As String

            <DataMember(Order:=100)>
            Public Overridable Property CarrierCodes As String

            <DataMember(Order:=110)>
            Public Overridable Property OperatingCarrierCodes As String

            <DataMember(Order:=120)>
            Public Overridable Property BoardPoint As String

            <DataMember(Order:=130)>
            Public Overridable Property FlightNumbers As String

            <DataMember(Order:=140)>
            Public Overridable Property EmailAddress As String

            <DataMember(Order:=150)>
            Public Overridable Property PhoneNbr As String

            <DataMember(Order:=160)>
            Public Overridable Property OwningAgencyLocationID As String

            <DataMember(Order:=170)>
            Public Overridable Property IataCodes As String

            <DataMember(Order:=180)>
            Public Overridable Property CustomFields As CustomFieldsCollection Implements IBookingCustomFields.CustomFields

            <DataMember(Order:=190)>
            Public Overridable Property DepartureDateTime As Date?

            <DataMember(Order:=200)>
            Public Overridable Property SegmentType As String

            <DataMember(Order:=210)>
            Public Overridable Property PNRCreationDate As Date? Implements IBookingIdentifier.PNRCreationDate

            <DataMember(Order:=220)>
            Public Overridable Property TicketNumbers As String() Implements ITicketNumbers.TicketNumbers

            <DataMember(Order:=230)>
            Public Overridable Property VendorLocators As BookingExtVendorLocator() Implements IVendorLocators.VendorLocators
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerLocationsByAirlineItemResponse
            Inherits ItemResponse(Of PassengerLocationAirline, PassengerLocationsByAirlineResponseReport)
        End Class

        <DataContract(Name:="PassengerLocationAirline", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerLocationsByAirlineResponseReport
            Inherits Report(Of PassengerLocationsByAirlineItemResponse, PassengerLocationAirline)
        End Class

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ResponseMetadata
            <DataMember(Order:=0)>
            Public Overridable Property Success As Boolean

            <DataMember(Order:=1)>
            Public Overridable Property HasCache As Boolean

            <DataMember(Order:=2)>
            Public Overridable Property HasPaging As Boolean

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CacheMetadata As CacheMetadata

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property PagingMetadata As PagingMetadata
        End Class
    End Namespace
End Namespace

VB.NET GetPassengerLocationsByAirline DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /PassengerLocationsByAirlineCity HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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","OwningConsultantID":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PnrTicketed":"String","PaxList":"String","Account":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","OperatingCarrierCodes":"String","BoardPoint":"String","FlightNumbers":"String","EmailAddress":"String","PhoneNbr":"String","OwningAgencyLocationID":"String","IataCodes":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}