Agentivity API

<back to all web services

GetPassengerLocationsByCountry

The following routes are available for this service:
GET/PassengerLocationsByCountry
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 CollectionResponse(Of TItem)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

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

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        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:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ApiRequestPerHour
            <DataMember(Order:=10)>
            Public Overridable Property RequestDate As Date

            <DataMember(Order:=100)>
            Public Overridable Property Hour0 As Integer

            <DataMember(Order:=110)>
            Public Overridable Property Hour1 As Integer

            <DataMember(Order:=120)>
            Public Overridable Property Hour2 As Integer

            <DataMember(Order:=130)>
            Public Overridable Property Hour3 As Integer

            <DataMember(Order:=140)>
            Public Overridable Property Hour4 As Integer

            <DataMember(Order:=150)>
            Public Overridable Property Hour5 As Integer

            <DataMember(Order:=160)>
            Public Overridable Property Hour6 As Integer

            <DataMember(Order:=170)>
            Public Overridable Property Hour7 As Integer

            <DataMember(Order:=180)>
            Public Overridable Property Hour8 As Integer

            <DataMember(Order:=190)>
            Public Overridable Property Hour9 As Integer

            <DataMember(Order:=200)>
            Public Overridable Property Hour10 As Integer

            <DataMember(Order:=210)>
            Public Overridable Property Hour11 As Integer

            <DataMember(Order:=220)>
            Public Overridable Property Hour12 As Integer

            <DataMember(Order:=230)>
            Public Overridable Property Hour13 As Integer

            <DataMember(Order:=240)>
            Public Overridable Property Hour14 As Integer

            <DataMember(Order:=250)>
            Public Overridable Property Hour15 As Integer

            <DataMember(Order:=260)>
            Public Overridable Property Hour16 As Integer

            <DataMember(Order:=270)>
            Public Overridable Property Hour17 As Integer

            <DataMember(Order:=280)>
            Public Overridable Property Hour18 As Integer

            <DataMember(Order:=290)>
            Public Overridable Property Hour19 As Integer

            <DataMember(Order:=300)>
            Public Overridable Property Hour20 As Integer

            <DataMember(Order:=310)>
            Public Overridable Property Hour21 As Integer

            <DataMember(Order:=320)>
            Public Overridable Property Hour22 As Integer

            <DataMember(Order:=330)>
            Public Overridable Property Hour23 As Integer
        End Class

        <DataContract(Name:="Passenger", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class BookingPassengerModel
            <DataMember(Order:=10)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=20)>
            Public Overridable Property LastName As String

            <DataMember(Order:=30)>
            Public Overridable Property PassengerDataId As Integer
        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

        <Flags>
        Public Enum FormattingStyle
            None = 0
            Html = 1
            Charting = 2
        End Enum

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class GetPassengerLocationsByCountry
            Inherits CompanyLevelRequestBase
            Implements IRepeatByPassenger
            '''<Summary>
            '''2 letter country code
            '''</Summary>
            <DataMember>
            Public Overridable Property CountryCode As String

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

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

            '''<Summary>
            '''Include passengers that are in transit only in response
            '''</Summary>
            <DataMember>
            Public Overridable Property InTransitOnly As Boolean?

            '''<Summary>
            '''Comma Delimited List of Accounts
            '''</Summary>
            <DataMember>
            Public Overridable Property Account As String()

            <DataMember>
            Public Overridable Property modifier As String

            <DataMember>
            Public Overridable Property IncludeItinerary As Boolean

            <DataMember>
            Public Overridable Property ItineraryFormatting As FormattingStyle

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

            '''<Summary>
            '''Option to place passenger names on separate lines in the downloadable result (spreadsheet)
            '''</Summary>
            <DataMember>
            Public Overridable Property RepeatByPassenger As Boolean Implements IRepeatByPassenger.RepeatByPassenger
        End Class

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

            <DataMember>
            Public Overridable Property SegmentNbr As Integer

            <DataMember>
            Public Overridable Property BoardPoint As String

            <DataMember>
            Public Overridable Property OffPoint As String

            <DataMember>
            Public Overridable Property OperatorCode As String

            <DataMember>
            Public Overridable Property OperatorService As String

            <DataMember>
            Public Overridable Property SegmentStatus As String

            <DataMember>
            Public Overridable Property DepartureTimeFormatted As String

            <DataMember>
            Public Overridable Property ArrivalTimeFormatted As String

            <DataMember>
            Public Overridable Property ChangeOfDayFormatted As String

            <DataMember>
            Public Overridable Property ServiceCode As String

            <DataMember>
            Public Overridable Property StartDate As String

            <DataMember>
            Public Overridable Property EndDate As String

            <DataMember>
            Public Overridable Property TicketNumber As String

            '''<Summary>
            '''Comma separated list of vendor locators
            '''</Summary>
            <DataMember>
            Public Overridable Property VendorLocators As String

            <DataMember>
            Public Overridable Property EquipmentCode As String

            <DataMember>
            Public Overridable Property Equipment As String
        End Class

        Public Partial Class ItinerarySegmentsCollection
            Inherits List(Of ItinerarySegment)
        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:="Segment", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerLocation
            Implements IBookingItinerary
            Implements IBookingCustomFields
            Implements IBookingIdentifier
            Implements ITicketNumbers
            Implements IVendorLocators
            Implements IPassengerInfo
            <DataMember(Order:=1)>
            Public Overridable Property RecordLocator As String Implements IBookingIdentifier.RecordLocator

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

            <DataMember(Order:=3)>
            Public Overridable Property DepartureDate As Date?

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

            <DataMember(Order:=5)>
            Public Overridable Property OffPoint As String

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

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

            <DataMember(Order:=8)>
            Public Overridable Property Consultant As String

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

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

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

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

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

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

            <DataMember(Order:=16)>
            Public Overridable Property HotelsNames As String

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

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

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

            <DataMember(Order:=15)>
            Public Overridable Property AgentivityRef As Integer Implements IBookingIdentifier.AgentivityRef

            <DataMember(Order:=120)>
            Public Overridable Property Itinerary As ItinerarySegmentsCollection Implements IBookingItinerary.Itinerary

            <DataMember(Order:=130)>
            Public Overridable Property ItineraryFormatted As String Implements IBookingItinerary.ItineraryFormatted

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

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

            <DataMember(Order:=160)>
            Public Overridable Property CurrentArrivalDateTime As Date?

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

            <DataMember(Order:=180)>
            Public Overridable Property AirSegmentNbr As String

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

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

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

            <DataMember(Order:=220)>
            Public Overridable Property PassengerInfo As BookingPassengerModel() Implements IPassengerInfo.PassengerInfo
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerLocationsByCountryResponse
            Inherits CollectionResponse(Of PassengerLocation)
        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 GetPassengerLocationsByCountry DTOs

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

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