Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

The following routes are available for this service:
GET/AirlineTicketRevenues
"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 AirlineTicketRevenue {
    /** @param {{PlatingCarrier?:string,AirlineShortName?:string,TotalFares?:number,TotalTax?:number,TotalBaseRevenue?:number,FormattedCarrierPlatingName?:string,PrintedCurrency?:string,FormattedTotalFares?:string,FormattedTotalTax?:string,FormattedTotalBaseRevenue?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PlatingCarrier;
    /** @type {string} */
    AirlineShortName;
    /** @type {?number} */
    TotalFares;
    /** @type {?number} */
    TotalTax;
    /** @type {?number} */
    TotalBaseRevenue;
    /** @type {string} */
    FormattedCarrierPlatingName;
    /** @type {string} */
    PrintedCurrency;
    /** @type {string} */
    FormattedTotalFares;
    /** @type {string} */
    FormattedTotalTax;
    /** @type {string} */
    FormattedTotalBaseRevenue;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class AirlineTicketRevenuesResponseReport extends Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
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 AirlineTicketRevenuesItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetCompanyTicketRevenuePerAirline extends PagingMetadata {
    /** @param {{TravelAgentID?:string,PlatingCarrier?:string,DepartureDateStart?:string,DepartureDateEnd?:string,FlightCouponStatus?:string,UserName?:string,AirlineCode?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of a travel agent */
    TravelAgentID;
    /**
     * @type {string}
     * @description Code for Plating Carrier */
    PlatingCarrier;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DepartureDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    DepartureDateEnd;
    /**
     * @type {string}
     * @description One letter code for flight coupon status */
    FlightCouponStatus;
    /**
     * @type {string}
     * @description UserName in form of an email address */
    UserName;
    /**
     * @type {string}
     * @description Two letter airline code */
    AirlineCode;
}

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