Agentivity API

<back to all web services

TicketRevenueByCompany

The following routes are available for this service:
GET/TicketRevenue/Company
"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 TicketRevenue {
    /** @param {{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?:number,TicketTax?:number,TicketBaseFare?:number,Tax1Code?:string,Tax1Amt?:string,Tax2Code?:string,Tax2Amt?:string,Tax3Code?:string,Tax3Amt?:string,Tax4Code?:string,Tax4Amt?:string,Tax5Code?:string,Tax5Amt?:string,Passenger?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TktNumber;
    /** @type {string} */
    PlatingCarrier;
    /** @type {string} */
    RecordLocator;
    /** @type {string} */
    Consultant;
    /** @type {string} */
    Account;
    /** @type {string} */
    FOP;
    /** @type {string} */
    PrintedCurrency;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    PCC;
    /** @type {string} */
    TicketIssueDate;
    /** @type {string} */
    IATA;
    /** @type {?number} */
    Revenue;
    /** @type {?number} */
    TicketTax;
    /** @type {?number} */
    TicketBaseFare;
    /** @type {string} */
    Tax1Code;
    /** @type {string} */
    Tax1Amt;
    /** @type {string} */
    Tax2Code;
    /** @type {string} */
    Tax2Amt;
    /** @type {string} */
    Tax3Code;
    /** @type {string} */
    Tax3Amt;
    /** @type {string} */
    Tax4Code;
    /** @type {string} */
    Tax4Amt;
    /** @type {string} */
    Tax5Code;
    /** @type {string} */
    Tax5Amt;
    /** @type {string} */
    Passenger;
}
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 ApiRequestPerHour {
    /** @param {{RequestDate?:string,Hour0?:number,Hour1?:number,Hour2?:number,Hour3?:number,Hour4?:number,Hour5?:number,Hour6?:number,Hour7?:number,Hour8?:number,Hour9?:number,Hour10?:number,Hour11?:number,Hour12?:number,Hour13?:number,Hour14?:number,Hour15?:number,Hour16?:number,Hour17?:number,Hour18?:number,Hour19?:number,Hour20?:number,Hour21?:number,Hour22?:number,Hour23?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RequestDate;
    /** @type {number} */
    Hour0;
    /** @type {number} */
    Hour1;
    /** @type {number} */
    Hour2;
    /** @type {number} */
    Hour3;
    /** @type {number} */
    Hour4;
    /** @type {number} */
    Hour5;
    /** @type {number} */
    Hour6;
    /** @type {number} */
    Hour7;
    /** @type {number} */
    Hour8;
    /** @type {number} */
    Hour9;
    /** @type {number} */
    Hour10;
    /** @type {number} */
    Hour11;
    /** @type {number} */
    Hour12;
    /** @type {number} */
    Hour13;
    /** @type {number} */
    Hour14;
    /** @type {number} */
    Hour15;
    /** @type {number} */
    Hour16;
    /** @type {number} */
    Hour17;
    /** @type {number} */
    Hour18;
    /** @type {number} */
    Hour19;
    /** @type {number} */
    Hour20;
    /** @type {number} */
    Hour21;
    /** @type {number} */
    Hour22;
    /** @type {number} */
    Hour23;
}
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} */
export class CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {ApiRequestPerHour[]} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class TicketRevenueByCompanyResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class TicketRevenueByCompany extends PagingMetadata {
    /** @param {{CompanyID?:number,TravelAgentID?:string,PlatingCarrier?:string,DepartureDateStart?:string,DepartureDateEnd?:string,FlightCouponStatus?:string,AirlineCode?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    CompanyID;
    /** @type {string} */
    TravelAgentID;
    /** @type {string} */
    PlatingCarrier;
    /** @type {string} */
    DepartureDateStart;
    /** @type {string} */
    DepartureDateEnd;
    /** @type {string} */
    FlightCouponStatus;
    /** @type {string} */
    AirlineCode;
}

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