Agentivity API

<back to all web services

GetPassengerLocationsByAirline

The following routes are available for this service:
GET/PassengerLocationsByAirlineCityDepreciated, do not use
GET/PassengerLocationsByAirline
import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetPassengerLocationsByAirline : CompanyLevelRequestBase
{
    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    public var account:[String]

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var dateStart:String

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var dateEnd:String

    /**
    * Two letter code for carrier
    */
    // @DataMember
    public var carrierCode:String

    /**
    * 3 letter city code
    */
    // @DataMember
    public var cityCode:String

    /**
    * Search operating vendor
    */
    // @DataMember
    public var searchOperatingVendor:Bool

    /**
    * Comma Delimited List of Custom Fields
    */
    // @DataMember
    public var customField:[String]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case account
        case dateStart
        case dateEnd
        case carrierCode
        case cityCode
        case searchOperatingVendor
        case customField
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        account = try container.decodeIfPresent([String].self, forKey: .account) ?? []
        dateStart = try container.decodeIfPresent(String.self, forKey: .dateStart)
        dateEnd = try container.decodeIfPresent(String.self, forKey: .dateEnd)
        carrierCode = try container.decodeIfPresent(String.self, forKey: .carrierCode)
        cityCode = try container.decodeIfPresent(String.self, forKey: .cityCode)
        searchOperatingVendor = try container.decodeIfPresent(Bool.self, forKey: .searchOperatingVendor)
        customField = try container.decodeIfPresent([String].self, forKey: .customField) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if account != nil { try container.encode(account, forKey: .account) }
        if dateStart != nil { try container.encode(dateStart, forKey: .dateStart) }
        if dateEnd != nil { try container.encode(dateEnd, forKey: .dateEnd) }
        if carrierCode != nil { try container.encode(carrierCode, forKey: .carrierCode) }
        if cityCode != nil { try container.encode(cityCode, forKey: .cityCode) }
        if searchOperatingVendor != nil { try container.encode(searchOperatingVendor, forKey: .searchOperatingVendor) }
        if customField != nil { try container.encode(customField, forKey: .customField) }
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class CompanyLevelRequestBase : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    // @DataMember
    public var owningCompanyCode:[String]

    /**
    * UserName in form of an email address
    */
    // @DataMember
    public var userName:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case owningCompanyCode
        case userName
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        owningCompanyCode = try container.decodeIfPresent([String].self, forKey: .owningCompanyCode) ?? []
        userName = try container.decodeIfPresent(String.self, forKey: .userName)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if owningCompanyCode != nil { try container.encode(owningCompanyCode, forKey: .owningCompanyCode) }
        if userName != nil { try container.encode(userName, forKey: .userName) }
    }
}

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public class PagingMetadata : Codable
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public var offset:String

    /**
    * Number of records to return (PageSize)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public var limit:String

    /**
    * 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")
    public var totalRecords:Int

    /**
    * 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")
    public var responseRecords:Int

    required public init(){}
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class PassengerLocationsByAirlineItemResponse : ItemResponse<PassengerLocationAirline, PassengerLocationsByAirlineResponseReport>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class ItemResponse<TItem : Codable, TReport : Codable> : Codable
{
    // @DataMember(Order=1)
    public var responseMetadata:ResponseMetadata

    // @DataMember(Order=2, EmitDefaultValue=false)
    public var responseReport:TReport

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var responseError:AgentivityError

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class ResponseMetadata : Codable
{
    // @DataMember(Order=0)
    public var success:Bool

    // @DataMember(Order=1)
    public var hasCache:Bool

    // @DataMember(Order=2)
    public var hasPaging:Bool

    // @DataMember(Order=3, EmitDefaultValue=false)
    public var cacheMetadata:CacheMetadata

    // @DataMember(Order=4, EmitDefaultValue=false)
    public var pagingMetadata:PagingMetadata

    required public init(){}
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public class CacheMetadata : Codable
{
    // @DataMember(Order=1)
    public var cachedAt:Date

    // @DataMember(Order=2)
    public var cacheExpiresAt:Date

    // @DataMember(Order=0)
    public var isFromCache:Bool

    required public init(){}
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public class AgentivityError : Codable
{
    // @DataMember
    public var errorCode:String

    // @DataMember
    public var message:String

    // @DataMember
    public var statusCode:String

    // @DataMember
    public var verboseMessage:String

    required public init(){}
}

// @DataContract(Name="PassengerLocationAirline", Namespace="schemas.agentivity.com/types")
public class PassengerLocationAirline : IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, Codable
{
    // @DataMember(Order=10)
    public var agentivityRef:Int

    // @DataMember(Order=20)
    public var recordLocator:String

    // @DataMember(Order=30)
    public var owningConsultantID:String

    // @DataMember(Order=40)
    public var travelDate:Date?

    // @DataMember(Order=50)
    public var pnrTicketed:String

    // @DataMember(Order=60)
    public var paxList:String

    // @DataMember(Order=70)
    public var account:String

    // @DataMember(Order=80)
    public var destinationCities:String

    // @DataMember(Order=90)
    public var connections:String

    // @DataMember(Order=100)
    public var carrierCodes:String

    // @DataMember(Order=110)
    public var operatingCarrierCodes:String

    // @DataMember(Order=120)
    public var boardPoint:String

    // @DataMember(Order=130)
    public var flightNumbers:String

    // @DataMember(Order=140)
    public var emailAddress:String

    // @DataMember(Order=150)
    public var phoneNbr:String

    // @DataMember(Order=160)
    public var owningAgencyLocationID:String

    // @DataMember(Order=170)
    public var iataCodes:String

    // @DataMember(Order=180)
    public var customFields:CustomFieldsCollection

    // @DataMember(Order=190)
    public var departureDateTime:Date?

    // @DataMember(Order=200)
    public var segmentType:String

    // @DataMember(Order=210)
    public var pnrCreationDate:Date?

    // @DataMember(Order=220)
    public var ticketNumbers:[String]

    // @DataMember(Order=230)
    public var vendorLocators:[BookingExtVendorLocator]

    required public init(){}
}

public class CustomFieldsCollection : List<CustomFieldData>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
public class CustomFieldData : Codable
{
    // @DataMember(Order=20)
    public var fieldName:String

    // @DataMember(Order=30)
    public var fieldValue:String

    required public init(){}
}

// @DataContract(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
public class BookingExtVendorLocator : IBookingIdentifier, Codable
{
    // @DataMember(Order=10)
    public var carrierCode:String

    // @DataMember(Order=20)
    public var vendorLocator:String

    required public init(){}
}

// @DataContract(Name="PassengerLocationAirline", Namespace="schemas.agentivity.com/types")
public class PassengerLocationsByAirlineResponseReport : Report<PassengerLocationsByAirlineItemResponse, PassengerLocationAirline>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
public class Report<TItemResponse : Codable, TItem : Codable> : Codable
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public var item:TItem

    required public init(){}
}

Swift GetPassengerLocationsByAirline 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 /PassengerLocationsByAirlineCity 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>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningConsultantID>String</OwningConsultantID>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <PnrTicketed>String</PnrTicketed>
      <PaxList>String</PaxList>
      <Account>String</Account>
      <DestinationCities>String</DestinationCities>
      <Connections>String</Connections>
      <CarrierCodes>String</CarrierCodes>
      <OperatingCarrierCodes>String</OperatingCarrierCodes>
      <BoardPoint>String</BoardPoint>
      <FlightNumbers>String</FlightNumbers>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <IataCodes>String</IataCodes>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
      <DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
      <SegmentType>String</SegmentType>
      <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>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>