| GET | /TicketDetails/User | Depreciated, please use ticketdetails | |
|---|---|---|---|
| GET | /TicketDetails |
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetTicketDetails : CompanyLevelRequestBase, IRequestConsultantID
{
/**
* Ticket number
*/
// @DataMember
public var tktNumber:String
/**
* Cache Guid
*/
// @DataMember
public var cacheGuid:String
/**
* Request Consultant ID (sign on)
*/
// @DataMember
public var requestConsultantID:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case tktNumber
case cacheGuid
case requestConsultantID
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
tktNumber = try container.decodeIfPresent(String.self, forKey: .tktNumber)
cacheGuid = try container.decodeIfPresent(String.self, forKey: .cacheGuid)
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 tktNumber != nil { try container.encode(tktNumber, forKey: .tktNumber) }
if cacheGuid != nil { try container.encode(cacheGuid, forKey: .cacheGuid) }
if requestConsultantID != nil { try container.encode(requestConsultantID, forKey: .requestConsultantID) }
}
}
// @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 TicketDetailsItemResponse : ItemResponse<TicketInfo, TicketDetailsResponseReport>
{
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="TicketInfo", Namespace="schemas.agentivity.com/types")
public class TicketInfo : Codable
{
// @DataMember(Order=5)
public var passengerTicketID:Int
// @DataMember(Order=10)
public var tktNumber:String
// @DataMember(Order=20)
public var recordLocator:String
// @DataMember(Order=30)
public var pnrCreationDate:Date?
// @DataMember(Order=40)
public var tktIssueDate:Date?
// @DataMember(Order=50)
public var platingCarrier:String
// @DataMember(Order=60)
public var status:String
// @DataMember(Order=70)
public var bar:String
// @DataMember(Order=80)
public var par:String
// @DataMember(Order=90)
public var lastName:String
// @DataMember(Order=100)
public var firstName:String
// @DataMember(Order=110)
public var ticketExpiryDate:Date?
// @DataMember(Order=120)
public var fop:String
// @DataMember(Order=130)
public var fopFare:String
// @DataMember(Order=140)
public var fopCurrency:String
// @DataMember(Order=150)
public var printedCurrency:String
// @DataMember(Order=160)
public var printedFare:String
// @DataMember(Order=170)
public var creditCardFOPAcct:String
// @DataMember(Order=180)
public var owningAgencyLocationID:String
// @DataMember(Order=190)
public var iata:String
// @DataMember(Order=200)
public var coupons:[TicketInfoFlightCoupon]
// @DataMember(Order=210)
public var eligibleForRefund:Bool
// @DataMember(Order=220)
public var eligibleForCovidStatus:Bool
// @DataMember(Order=230)
public var ticketExchanges:[TicketExchange]
// @DataMember(Order=240)
public var tax:TicketTaxDetails
// @DataMember(Order=500)
public var owningCompanyCode:String
required public init(){}
}
// @DataContract(Name="TicketInfoFlightCoupon", Namespace="schemas.agentivity.com/types")
public class TicketInfoFlightCoupon : Codable
{
// @DataMember(Order=10)
public var tktNumber:String
// @DataMember(Order=20)
public var couponSequenceNbr:Int
// @DataMember(Order=20)
public var carrier:String
// @DataMember(Order=30)
public var flightNbr:String
// @DataMember(Order=40)
public var boardPoint:String
// @DataMember(Order=50)
public var offPoint:String
// @DataMember(Order=60)
public var flightServiceClass:String
// @DataMember(Order=70)
public var flightDate:Date?
// @DataMember(Order=80)
public var flightCouponStatus:String
// @DataMember(Order=90)
public var dateLastChecked:Date?
// @DataMember(Order=100)
public var airTktSegId:Int
// @DataMember(Order=110)
public var eligibleForRefund:Bool
// @DataMember(Order=120)
public var eligibleForCovidStatus:Bool
// @DataMember(Order=130)
public var fareBasis:String
required public init(){}
}
// @DataContract(Name="Exchange", Namespace="schemas.agentivity.com/types")
public class TicketExchange : Codable
{
// @DataMember(Order=10)
public var originalTktNumber:String
required public init(){}
}
// @DataContract(Name="Tax", Namespace="schemas.agentivity.com/types")
public class TicketTaxDetails : Codable
{
// @DataMember(Order=10)
public var totalAmt:Double?
// @DataMember(Order=20)
public var taxElements:[TicketTaxElement]
required public init(){}
}
// @DataContract(Name="TaxElement", Namespace="schemas.agentivity.com/types")
public class TicketTaxElement : Codable
{
// @DataMember(Order=10)
public var amt:Double?
// @DataMember(Order=20)
public var printedAmt:String
// @DataMember(Order=30)
public var code:String
required public init(){}
}
// @DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")
public class TicketDetailsResponseReport : Report<TicketDetailsItemResponse, TicketInfo>
{
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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /TicketDetails/User HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":{"PassengerTicketID":0,"TktNumber":"String","RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktIssueDate":"\/Date(-62135596800000-0000)\/","PlatingCarrier":"String","Status":"String","BAR":"String","PAR":"String","LastName":"String","FirstName":"String","TicketExpiryDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FopFare":"String","FOPCurrency":"String","PrintedCurrency":"String","PrintedFare":"String","CreditCardFOPAcct":"String","OwningAgencyLocationID":"String","IATA":"String","Coupons":[{"TktNumber":"String","CouponSequenceNbr":0,"Carrier":"String","FlightNbr":"String","BoardPoint":"String","OffPoint":"String","FlightServiceClass":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","AirTktSegId":0,"EligibleForRefund":false,"EligibleForCovidStatus":false,"FareBasis":"String"}],"EligibleForRefund":false,"EligibleForCovidStatus":false,"TicketExchanges":[{"OriginalTktNumber":"String"}],"Tax":{"TotalAmt":0,"TaxElements":[{"Amt":0,"PrintedAmt":"String","Code":"String"}]},"OwningCompanyCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}