Agentivity API

<back to all web services

GetDistributorBookingsTravellingByAirlineClass

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

// @DataContract(Namespace="schemas.agentivity.com/types")
public class GetDistributorBookingsTravellingByAirlineClass : PagingMetadata
{
    /**
    * ID of Distributor
    */
    // @DataMember
    public var distributorID:Int

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var issueDateStart:String

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    public var issueDateEnd:String

    /**
    * Two letter code for carrier
    */
    // @DataMember
    public var platingCarrier:String

    /**
    * Booking Class Name
    */
    // @DataMember
    public var bookingClassName:String

    /**
    * BoardPoint CountryCode
    */
    // @DataMember
    public var boardPointCountryCode:String

    /**
    * Include Itinerary in the response
    */
    // @DataMember
    public var includeItinerary:Bool

    /**
    * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
    */
    // @DataMember
    public var itineraryFormatting:FormattingStyle

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

    private enum CodingKeys : String, CodingKey {
        case distributorID
        case issueDateStart
        case issueDateEnd
        case platingCarrier
        case bookingClassName
        case boardPointCountryCode
        case includeItinerary
        case itineraryFormatting
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        distributorID = try container.decodeIfPresent(Int.self, forKey: .distributorID)
        issueDateStart = try container.decodeIfPresent(String.self, forKey: .issueDateStart)
        issueDateEnd = try container.decodeIfPresent(String.self, forKey: .issueDateEnd)
        platingCarrier = try container.decodeIfPresent(String.self, forKey: .platingCarrier)
        bookingClassName = try container.decodeIfPresent(String.self, forKey: .bookingClassName)
        boardPointCountryCode = try container.decodeIfPresent(String.self, forKey: .boardPointCountryCode)
        includeItinerary = try container.decodeIfPresent(Bool.self, forKey: .includeItinerary)
        itineraryFormatting = try container.decodeIfPresent(FormattingStyle.self, forKey: .itineraryFormatting)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if distributorID != nil { try container.encode(distributorID, forKey: .distributorID) }
        if issueDateStart != nil { try container.encode(issueDateStart, forKey: .issueDateStart) }
        if issueDateEnd != nil { try container.encode(issueDateEnd, forKey: .issueDateEnd) }
        if platingCarrier != nil { try container.encode(platingCarrier, forKey: .platingCarrier) }
        if bookingClassName != nil { try container.encode(bookingClassName, forKey: .bookingClassName) }
        if boardPointCountryCode != nil { try container.encode(boardPointCountryCode, forKey: .boardPointCountryCode) }
        if includeItinerary != nil { try container.encode(includeItinerary, forKey: .includeItinerary) }
        if itineraryFormatting != nil { try container.encode(itineraryFormatting, forKey: .itineraryFormatting) }
    }
}

// @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 DistributorBookingsByAirlineClassItemResponse : ItemResponse<BookingByAirlineWithClassSupport, BookingsByAirlineWithClassSupportResponseReport>
{
    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="BookingByAirlineWithClassSupport", Namespace="schemas.agentivity.com/types")
public class BookingByAirlineWithClassSupport : 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 account:String

    // @DataMember(Order=50)
    public var owningConsultant:String

    // @DataMember(Order=55)
    public var ticketedStatusCode:String

    // @DataMember(Order=60)
    public var ticketedStatus:String

    // @DataMember(Order=70)
    public var bookingCodesBooked:String

    // @DataMember(Order=80)
    public var flightNumbers:String

    // @DataMember(Order=90)
    public var routing:String

    // @DataMember(Order=100)
    public var trackingCode:String

    // @DataMember(Order=110)
    public var tktTourCode:String

    required public init(){}
}

// @DataContract(Name="BookingByAirlineWithClassSupport", Namespace="schemas.agentivity.com/types")
public class BookingsByAirlineWithClassSupportResponseReport : Report<BookingsByAirlineWithClassSupportItemResponse, BookingByAirlineWithClassSupport>
{
    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(){}
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public class BookingsByAirlineWithClassSupportItemResponse : ItemResponse<BookingByAirlineWithClassSupport, BookingsByAirlineWithClassSupportResponseReport>
{
    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)
    }
}


Swift GetDistributorBookingsTravellingByAirlineClass DTOs

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

HTTP + OTHER

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

GET /DistributorBookingsByAirlineClass 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":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Account":"String","OwningConsultant":"String","TicketedStatusCode":"String","TicketedStatus":"String","BookingCodesBooked":"String","FlightNumbers":"String","Routing":"String","TrackingCode":"String","TktTourCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}