Agentivity API

<back to all web services

GetDistributorBookingsTravellingByAirlineClass

The following routes are available for this service:
GET/DistributorBookingsByAirlineClass
"use strict";
export class PagingMetadata {
    /** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Starting Record */
    Offset;
    /**
     * @type {string}
     * @description Number of records to return (PageSize) */
    Limit;
    /**
     * @type {number}
     * @description Total Number of Records in a Full Reponse (if no paging) */
    TotalRecords;
    /**
     * @type {number}
     * @description Total Number of Records in this Reponse (on this page) */
    ResponseRecords;
}
export class BookingByAirlineWithClassSupport {
    /** @param {{AgentivityRef?:number,RecordLocator?:string,PNRCreationDate?:string,Account?:string,OwningConsultant?:string,TicketedStatusCode?:string,TicketedStatus?:string,BookingCodesBooked?:string,FlightNumbers?:string,Routing?:string,TrackingCode?:string,TktTourCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentivityRef;
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    Account;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    TicketedStatusCode;
    /** @type {string} */
    TicketedStatus;
    /** @type {string} */
    BookingCodesBooked;
    /** @type {string} */
    FlightNumbers;
    /** @type {string} */
    Routing;
    /** @type {string} */
    TrackingCode;
    /** @type {string} */
    TktTourCode;
}
export class CacheMetadata {
    /** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CachedAt;
    /** @type {string} */
    CacheExpiresAt;
    /** @type {boolean} */
    IsFromCache;
}
export class ResponseMetadata {
    /** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Success;
    /** @type {boolean} */
    HasCache;
    /** @type {boolean} */
    HasPaging;
    /** @type {CacheMetadata} */
    CacheMetadata;
    /** @type {PagingMetadata} */
    PagingMetadata;
}
export class AgentivityError {
    /** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    Message;
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    VerboseMessage;
}
/** @typedef TItem {any} */
/** @typedef  TReport {any} */
export class ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {TReport} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class BookingsByAirlineWithClassSupportItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class BookingsByAirlineWithClassSupportResponseReport extends Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class DistributorBookingsByAirlineClassItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var FormattingStyle;
(function (FormattingStyle) {
    FormattingStyle[FormattingStyle["None"] = 0] = "None"
    FormattingStyle[FormattingStyle["Html"] = 1] = "Html"
    FormattingStyle[FormattingStyle["Charting"] = 2] = "Charting"
})(FormattingStyle || (FormattingStyle = {}));
export class GetDistributorBookingsTravellingByAirlineClass extends PagingMetadata {
    /** @param {{DistributorID?:number,IssueDateStart?:string,IssueDateEnd?:string,PlatingCarrier?:string,BookingClassName?:string,BoardPointCountryCode?:string,IncludeItinerary?:boolean,ItineraryFormatting?:FormattingStyle,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description ID of Distributor */
    DistributorID;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    IssueDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    IssueDateEnd;
    /**
     * @type {string}
     * @description Two letter code for carrier */
    PlatingCarrier;
    /**
     * @type {string}
     * @description Booking Class Name */
    BookingClassName;
    /**
     * @type {string}
     * @description BoardPoint CountryCode */
    BoardPointCountryCode;
    /**
     * @type {boolean}
     * @description Include Itinerary in the response */
    IncludeItinerary;
    /**
     * @type {FormattingStyle}
     * @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
    ItineraryFormatting;
}

JavaScript 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"}}