Agentivity API

<back to all web services

TicketRevenueByCompany

The following routes are available for this service:
GET/TicketRevenue/Company
import Foundation
import ServiceStack

// @DataContract(Namespace="schemas.agentivity.com/types")
public class TicketRevenueByCompany : PagingMetadata
{
    // @DataMember
    public var companyID:Int?

    // @DataMember
    public var travelAgentID:String

    // @DataMember
    public var platingCarrier:String

    // @DataMember
    public var departureDateStart:String

    // @DataMember
    public var departureDateEnd:String

    // @DataMember
    public var flightCouponStatus:String

    // @DataMember
    public var airlineCode:String

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

    private enum CodingKeys : String, CodingKey {
        case companyID
        case travelAgentID
        case platingCarrier
        case departureDateStart
        case departureDateEnd
        case flightCouponStatus
        case airlineCode
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyID = try container.decodeIfPresent(Int.self, forKey: .companyID)
        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)
        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 companyID != nil { try container.encode(companyID, forKey: .companyID) }
        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 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 TicketRevenueByCompanyResponse : CollectionResponse<TicketRevenue>
{
    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="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
public class TicketRevenue : Codable
{
    // @DataMember
    public var tktNumber:String

    // @DataMember
    public var platingCarrier:String

    // @DataMember
    public var recordLocator:String

    // @DataMember
    public var consultant:String

    // @DataMember
    public var account:String

    // @DataMember
    public var fop:String

    // @DataMember
    public var printedCurrency:String

    // @DataMember
    public var firstName:String

    // @DataMember
    public var lastName:String

    // @DataMember
    public var pcc:String

    // @DataMember
    public var ticketIssueDate:String

    // @DataMember
    public var iata:String

    // @DataMember
    public var revenue:Double?

    // @DataMember
    public var ticketTax:Double?

    // @DataMember
    public var ticketBaseFare:Double?

    // @DataMember
    public var tax1Code:String

    // @DataMember
    public var tax1Amt:String

    // @DataMember
    public var tax2Code:String

    // @DataMember
    public var tax2Amt:String

    // @DataMember
    public var tax3Code:String

    // @DataMember
    public var tax3Amt:String

    // @DataMember
    public var tax4Code:String

    // @DataMember
    public var tax4Amt:String

    // @DataMember
    public var tax5Code:String

    // @DataMember
    public var tax5Amt:String

    // @DataMember
    public var passenger:String

    required public init(){}
}

Swift TicketRevenueByCompany DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /TicketRevenue/Company HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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":[{"TktNumber":"String","PlatingCarrier":"String","RecordLocator":"String","Consultant":"String","Account":"String","FOP":"String","PrintedCurrency":"String","FirstName":"String","LastName":"String","PCC":"String","TicketIssueDate":"String","IATA":"String","Revenue":0,"TicketTax":0,"TicketBaseFare":0,"Tax1Code":"String","Tax1Amt":"String","Tax2Code":"String","Tax2Amt":"String","Tax3Code":"String","Tax3Amt":"String","Tax4Code":"String","Tax4Amt":"String","Tax5Code":"String","Tax5Amt":"String","Passenger":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}