| GET | /AirlineTicketRevenues |
|---|
import Foundation
import ServiceStack
// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetCompanyTicketRevenuePerAirline : PagingMetadata
{
/**
* ID of a travel agent
*/
// @DataMember
public var travelAgentID:String
/**
* Code for Plating Carrier
*/
// @DataMember
public var platingCarrier:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var departureDateStart:String
/**
* Date in format YYYYMMDD
*/
// @DataMember
public var departureDateEnd:String
/**
* One letter code for flight coupon status
*/
// @DataMember
public var flightCouponStatus:String
/**
* UserName in form of an email address
*/
// @DataMember
public var userName:String
/**
* Two letter airline code
*/
// @DataMember
public var airlineCode:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case travelAgentID
case platingCarrier
case departureDateStart
case departureDateEnd
case flightCouponStatus
case userName
case airlineCode
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
travelAgentID = try container.decodeIfPresent(String.self, forKey: .travelAgentID)
platingCarrier = try container.decodeIfPresent(String.self, forKey: .platingCarrier)
departureDateStart = try container.decodeIfPresent(String.self, forKey: .departureDateStart)
departureDateEnd = try container.decodeIfPresent(String.self, forKey: .departureDateEnd)
flightCouponStatus = try container.decodeIfPresent(String.self, forKey: .flightCouponStatus)
userName = try container.decodeIfPresent(String.self, forKey: .userName)
airlineCode = try container.decodeIfPresent(String.self, forKey: .airlineCode)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if travelAgentID != nil { try container.encode(travelAgentID, forKey: .travelAgentID) }
if platingCarrier != nil { try container.encode(platingCarrier, forKey: .platingCarrier) }
if departureDateStart != nil { try container.encode(departureDateStart, forKey: .departureDateStart) }
if departureDateEnd != nil { try container.encode(departureDateEnd, forKey: .departureDateEnd) }
if flightCouponStatus != nil { try container.encode(flightCouponStatus, forKey: .flightCouponStatus) }
if userName != nil { try container.encode(userName, forKey: .userName) }
if airlineCode != nil { try container.encode(airlineCode, forKey: .airlineCode) }
}
}
// @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 AirlineTicketRevenuesItemResponse : ItemResponse<AirlineTicketRevenue, AirlineTicketRevenuesResponseReport>
{
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="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
public class AirlineTicketRevenue : Codable
{
// @DataMember(Order=10)
public var platingCarrier:String
// @DataMember(Order=20)
public var airlineShortName:String
// @DataMember(Order=30)
public var totalFares:Double?
// @DataMember(Order=40)
public var totalTax:Double?
// @DataMember(Order=50)
public var totalBaseRevenue:Double?
// @DataMember(Order=60)
public var formattedCarrierPlatingName:String
// @DataMember(Order=70)
public var printedCurrency:String
// @DataMember(Order=80)
public var formattedTotalFares:String
// @DataMember(Order=90)
public var formattedTotalTax:String
// @DataMember(Order=100)
public var formattedTotalBaseRevenue:String
required public init(){}
}
// @DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
public class AirlineTicketRevenuesResponseReport : Report<AirlineTicketRevenuesItemResponse, AirlineTicketRevenue>
{
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 GetCompanyTicketRevenuePerAirline DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /AirlineTicketRevenues HTTP/1.1 Host: api.agentivity.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{"PlatingCarrier":"String","AirlineShortName":"String","TotalFares":0,"TotalTax":0,"TotalBaseRevenue":0,"FormattedCarrierPlatingName":"String","PrintedCurrency":"String","FormattedTotalFares":"String","FormattedTotalTax":"String","FormattedTotalBaseRevenue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}