Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

"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

GET /AirlineTicketRevenues HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <PlatingCarrier>String</PlatingCarrier>
      <AirlineShortName>String</AirlineShortName>
      <TotalFares>0</TotalFares>
      <TotalTax>0</TotalTax>
      <TotalBaseRevenue>0</TotalBaseRevenue>
      <FormattedCarrierPlatingName>String</FormattedCarrierPlatingName>
      <PrintedCurrency>String</PrintedCurrency>
      <FormattedTotalFares>String</FormattedTotalFares>
      <FormattedTotalTax>String</FormattedTotalTax>
      <FormattedTotalBaseRevenue>String</FormattedTotalBaseRevenue>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>