| GET | /PassengerLocationsByCountry |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetPassengerLocationsByCountry : CompanyLevelRequestBase, IRepeatByPassenger
{
/**
* 2 letter country code
*/
// @DataMember
public var countryCode:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var dateEnd:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var dateStart:String
/**
* Include passengers that are in transit only in response
*/
// @DataMember
public var inTransitOnly:Bool?
/**
* Comma Delimited List of Accounts
*/
// @DataMember
public var account:[String]
// @DataMember
public var modifier:String
// @DataMember
public var includeItinerary:Bool
// @DataMember
public var itineraryFormatting:FormattingStyle
/**
* Comma Delimited List of Custom Fields
*/
// @DataMember
public var customField:[String]
/**
* Option to place passenger names on separate lines in the downloadable result (spreadsheet)
*/
// @DataMember
public var repeatByPassenger:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case countryCode
case dateEnd
case dateStart
case inTransitOnly
case account
case modifier
case includeItinerary
case itineraryFormatting
case customField
case repeatByPassenger
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
countryCode = try container.decodeIfPresent(String.self, forKey: .countryCode)
dateEnd = try container.decodeIfPresent(String.self, forKey: .dateEnd)
dateStart = try container.decodeIfPresent(String.self, forKey: .dateStart)
inTransitOnly = try container.decodeIfPresent(Bool.self, forKey: .inTransitOnly)
account = try container.decodeIfPresent([String].self, forKey: .account) ?? []
modifier = try container.decodeIfPresent(String.self, forKey: .modifier)
includeItinerary = try container.decodeIfPresent(Bool.self, forKey: .includeItinerary)
itineraryFormatting = try container.decodeIfPresent(FormattingStyle.self, forKey: .itineraryFormatting)
customField = try container.decodeIfPresent([String].self, forKey: .customField) ?? []
repeatByPassenger = try container.decodeIfPresent(Bool.self, forKey: .repeatByPassenger)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if countryCode != nil { try container.encode(countryCode, forKey: .countryCode) }
if dateEnd != nil { try container.encode(dateEnd, forKey: .dateEnd) }
if dateStart != nil { try container.encode(dateStart, forKey: .dateStart) }
if inTransitOnly != nil { try container.encode(inTransitOnly, forKey: .inTransitOnly) }
if account != nil { try container.encode(account, forKey: .account) }
if modifier != nil { try container.encode(modifier, forKey: .modifier) }
if includeItinerary != nil { try container.encode(includeItinerary, forKey: .includeItinerary) }
if itineraryFormatting != nil { try container.encode(itineraryFormatting, forKey: .itineraryFormatting) }
if customField != nil { try container.encode(customField, forKey: .customField) }
if repeatByPassenger != nil { try container.encode(repeatByPassenger, forKey: .repeatByPassenger) }
}
}
// @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(){}
}
// @Flags()
public enum FormattingStyle : Int, Codable
{
case None = 0
case Html = 1
case Charting = 2
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class PassengerLocationsByCountryResponse : CollectionResponse<PassengerLocation>
{
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 CollectionResponse<TItem : Codable> : Codable
{
// @DataMember(Order=1)
public var responseMetadata:ResponseMetadata
// @DataMember(Order=2, EmitDefaultValue=false)
public var responseReport:[ApiRequestPerHour]
// @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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
public class ApiRequestPerHour : Codable
{
// @DataMember(Order=10)
public var requestDate:Date
// @DataMember(Order=100)
public var hour0:Int
// @DataMember(Order=110)
public var hour1:Int
// @DataMember(Order=120)
public var hour2:Int
// @DataMember(Order=130)
public var hour3:Int
// @DataMember(Order=140)
public var hour4:Int
// @DataMember(Order=150)
public var hour5:Int
// @DataMember(Order=160)
public var hour6:Int
// @DataMember(Order=170)
public var hour7:Int
// @DataMember(Order=180)
public var hour8:Int
// @DataMember(Order=190)
public var hour9:Int
// @DataMember(Order=200)
public var hour10:Int
// @DataMember(Order=210)
public var hour11:Int
// @DataMember(Order=220)
public var hour12:Int
// @DataMember(Order=230)
public var hour13:Int
// @DataMember(Order=240)
public var hour14:Int
// @DataMember(Order=250)
public var hour15:Int
// @DataMember(Order=260)
public var hour16:Int
// @DataMember(Order=270)
public var hour17:Int
// @DataMember(Order=280)
public var hour18:Int
// @DataMember(Order=290)
public var hour19:Int
// @DataMember(Order=300)
public var hour20:Int
// @DataMember(Order=310)
public var hour21:Int
// @DataMember(Order=320)
public var hour22:Int
// @DataMember(Order=330)
public var hour23:Int
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="Segment", Namespace="schemas.agentivity.com/types")
public class PassengerLocation : IBookingItinerary, IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IPassengerInfo, Codable
{
// @DataMember(Order=1)
public var recordLocator:String
// @DataMember(Order=2)
public var travelDate:Date?
// @DataMember(Order=3)
public var departureDate:Date?
// @DataMember(Order=4)
public var boardPoint:String
// @DataMember(Order=5)
public var offPoint:String
// @DataMember(Order=6)
public var pnrTicketed:String
// @DataMember(Order=7)
public var account:String
// @DataMember(Order=8)
public var consultant:String
// @DataMember(Order=9)
public var paxList:String
// @DataMember(Order=10)
public var phoneNbr:String
// @DataMember(Order=11)
public var emailAddress:String
// @DataMember(Order=12)
public var destinationCities:String
// @DataMember(Order=13)
public var connections:String
// @DataMember(Order=14)
public var carrierCodes:String
// @DataMember(Order=16)
public var hotelsNames:String
// @DataMember(Order=30)
public var flightNumbers:String
// @DataMember(Order=40)
public var owningAgencyLocationID:String
// @DataMember(Order=50)
public var iataCodes:String
// @DataMember(Order=15)
public var agentivityRef:Int
// @DataMember(Order=120)
public var itinerary:ItinerarySegmentsCollection
// @DataMember(Order=130)
public var itineraryFormatted:String
// @DataMember(Order=140)
public var customFields:CustomFieldsCollection
// @DataMember(Order=150)
public var departureDateTime:Date?
// @DataMember(Order=160)
public var currentArrivalDateTime:Date?
// @DataMember(Order=170)
public var segmentType:String
// @DataMember(Order=180)
public var airSegmentNbr:String
// @DataMember(Order=190)
public var pnrCreationDate:Date?
// @DataMember(Order=200)
public var ticketNumbers:[String]
// @DataMember(Order=210)
public var vendorLocators:[BookingExtVendorLocator]
// @DataMember(Order=220)
public var passengerInfo:[BookingPassengerModel]
required public init(){}
}
public class ItinerarySegmentsCollection : List<ItinerarySegment>
{
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="ItinerarySegment", Namespace="schemas.agentivity.com/types")
public class ItinerarySegment : Codable
{
// @DataMember
public var segmentType:String
// @DataMember
public var segmentNbr:Int
// @DataMember
public var boardPoint:String
// @DataMember
public var offPoint:String
// @DataMember
public var operatorCode:String
// @DataMember
public var operatorService:String
// @DataMember
public var segmentStatus:String
// @DataMember
public var departureTimeFormatted:String
// @DataMember
public var arrivalTimeFormatted:String
// @DataMember
public var changeOfDayFormatted:String
// @DataMember
public var serviceCode:String
// @DataMember
public var startDate:String
// @DataMember
public var endDate:String
// @DataMember
public var ticketNumber:String
/**
* Comma separated list of vendor locators
*/
// @DataMember
public var vendorLocators:String
// @DataMember
public var equipmentCode:String
// @DataMember
public var equipment:String
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="Passenger", Namespace="schemas.agentivity.com/types")
public class BookingPassengerModel : Codable
{
// @DataMember(Order=10)
public var firstName:String
// @DataMember(Order=20)
public var lastName:String
// @DataMember(Order=30)
public var passengerDataId:Int
required public init(){}
}
Swift GetPassengerLocationsByCountry DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>