| All Verbs | /PNRInformation |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetPnrInfo : PagingMetadata, IRequestConsultantID
{
/**
* Record locator
*/
// @DataMember
public var recordLocator:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var pnrCreationDate:String
/**
* Request Consultant ID (sign on)
*/
// @DataMember
public var requestConsultantID:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case recordLocator
case pnrCreationDate
case requestConsultantID
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
recordLocator = try container.decodeIfPresent(String.self, forKey: .recordLocator)
pnrCreationDate = try container.decodeIfPresent(String.self, forKey: .pnrCreationDate)
requestConsultantID = try container.decodeIfPresent(String.self, forKey: .requestConsultantID)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if recordLocator != nil { try container.encode(recordLocator, forKey: .recordLocator) }
if pnrCreationDate != nil { try container.encode(pnrCreationDate, forKey: .pnrCreationDate) }
if requestConsultantID != nil { try container.encode(requestConsultantID, forKey: .requestConsultantID) }
}
}
// @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 GetPnrInfoResponse : CollectionResponse<PnrInfo>
{
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="PNRInformation", Namespace="schemas.agentivity.com/types")
public class PnrInfo : Codable
{
// @DataMember(Order=10)
public var agentivityRef:Int?
// @DataMember(Order=20)
public var recordLocator:String
// @DataMember(Order=30)
public var pnrCreationDate:Date?
// @DataMember(Order=35)
public var pnrTicketed:String
// @DataMember(Order=40)
public var owningConsultantID:String
// @DataMember(Order=45)
public var owningConsultant:String
// @DataMember(Order=50)
public var owningAgencyLocationID:String
// @DataMember(Order=60)
public var account:String
// @DataMember(Order=80)
public var hasDocs:Bool
// @DataMember(Order=90)
public var countryCount:Int
// @DataMember(Order=100)
public var mobile:String
// @DataMember(Order=110)
public var ctcmMobile:String
// @DataMember(Order=120)
public var ctce:String
// @DataMember(Order=200)
public var outOfHoursServicedIndicator:Int
// @DataMember(Order=210)
public var changeCount:Int
// @DataMember(Order=220)
public var itineraryChanges:Int
// @DataMember(Order=230)
public var tripID:String
// @DataMember(Order=235)
public var airlineTicketingDues:[PnrInfoAirlineTicketingDue]
// @DataMember(Order=240)
public var agentivityWarnings:[PnrInfoAgentivityWarning]
// @DataMember(Order=250)
public var cabin:String
// @DataMember(Order=300)
public var suspectedDupeCount:Int
// @DataMember(Order=310)
public var suspectedDupes:[PnrInfoSuspectedDuplicate]
// @DataMember(Order=320)
public var carbonTonnage:Double?
// @DataMember(Order=330)
public var travellerGUID:String
required public init(){}
}
// @DataContract(Name="TicketingDue", Namespace="schemas.agentivity.com/types")
public class PnrInfoAirlineTicketingDue : Codable
{
// @DataMember(Order=10)
public var airline:String
// @DataMember(Order=20)
public var dueDate:Date?
// @DataMember(Order=30)
public var dueTime:String
required public init(){}
}
// @DataContract(Name="Warning", Namespace="schemas.agentivity.com/types")
public class PnrInfoAgentivityWarning : Codable
{
// @DataMember(Order=10)
public var message:String
// @DataMember(Order=20)
public var vendor:String
// @DataMember(Order=30)
public var timestamp:Date?
// @DataMember(Order=40)
public var details:String
required public init(){}
}
// @DataContract(Name="SuspectedDupe", Namespace="schemas.agentivity.com/types")
public class PnrInfoSuspectedDuplicate : Codable
{
// @DataMember(Order=10)
public var agentivityRef:Int
// @DataMember(Order=20)
public var recordLocator:String
// @DataMember(Order=30)
public var pnrCreationDate:Date?
// @DataMember(Order=40)
public var destinationCities:String
// @DataMember(Order=50)
public var ticketed:String
required public init(){}
}
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.
POST /PNRInformation HTTP/1.1
Host: api.agentivity.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetPnrInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
<PNRCreationDate>String</PNRCreationDate>
<RecordLocator>String</RecordLocator>
<RequestConsultantID>String</RequestConsultantID>
</GetPnrInfo>
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>
<PNRInformation>
<AgentivityRef>0</AgentivityRef>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<PNRTicketed>String</PNRTicketed>
<OwningConsultantID>String</OwningConsultantID>
<OwningConsultant>String</OwningConsultant>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<Account>String</Account>
<HasDocs>false</HasDocs>
<CountryCount>0</CountryCount>
<Mobile>String</Mobile>
<CTCMMobile>String</CTCMMobile>
<CTCE>String</CTCE>
<OutOfHoursServicedIndicator>0</OutOfHoursServicedIndicator>
<ChangeCount>0</ChangeCount>
<ItineraryChanges>0</ItineraryChanges>
<TripID>String</TripID>
<AirlineTicketingDues>
<TicketingDue>
<Airline>String</Airline>
<DueDate>0001-01-01T00:00:00</DueDate>
<DueTime>String</DueTime>
</TicketingDue>
</AirlineTicketingDues>
<AgentivityWarnings>
<Warning>
<Message>String</Message>
<Vendor>String</Vendor>
<Timestamp>0001-01-01T00:00:00</Timestamp>
<Details>String</Details>
</Warning>
</AgentivityWarnings>
<Cabin>String</Cabin>
<SuspectedDupeCount>0</SuspectedDupeCount>
<SuspectedDupes>
<SuspectedDupe>
<AgentivityRef>0</AgentivityRef>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<DestinationCities>String</DestinationCities>
<Ticketed>String</Ticketed>
</SuspectedDupe>
</SuspectedDupes>
<CarbonTonnage>0</CarbonTonnage>
<TravellerGUID>String</TravellerGUID>
</PNRInformation>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>