Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

The following routes are available for this service:
GET/AirlineTicketRevenues

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description 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 TotalRecords: number;

    /** @description 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 ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
export class AirlineTicketRevenue
{
    // @DataMember(Order=10)
    public PlatingCarrier: string;

    // @DataMember(Order=20)
    public AirlineShortName: string;

    // @DataMember(Order=30)
    public TotalFares?: number;

    // @DataMember(Order=40)
    public TotalTax?: number;

    // @DataMember(Order=50)
    public TotalBaseRevenue?: number;

    // @DataMember(Order=60)
    public FormattedCarrierPlatingName: string;

    // @DataMember(Order=70)
    public PrintedCurrency: string;

    // @DataMember(Order=80)
    public FormattedTotalFares: string;

    // @DataMember(Order=90)
    public FormattedTotalTax: string;

    // @DataMember(Order=100)
    public FormattedTotalBaseRevenue: string;

    public constructor(init?: Partial<AirlineTicketRevenue>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
export class AirlineTicketRevenuesResponseReport extends Report<AirlineTicketRevenuesItemResponse, AirlineTicketRevenue>
{

    public constructor(init?: Partial<AirlineTicketRevenuesResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class AirlineTicketRevenuesItemResponse extends ItemResponse<AirlineTicketRevenue, AirlineTicketRevenuesResponseReport>
{

    public constructor(init?: Partial<AirlineTicketRevenuesItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetCompanyTicketRevenuePerAirline extends PagingMetadata
{
    /** @description ID of a travel agent */
    // @DataMember
    public TravelAgentID: string;

    /** @description Code for Plating Carrier */
    // @DataMember
    public PlatingCarrier: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DepartureDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DepartureDateEnd: string;

    /** @description One letter code for flight coupon status */
    // @DataMember
    public FlightCouponStatus: string;

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    /** @description Two letter airline code */
    // @DataMember
    public AirlineCode: string;

    public constructor(init?: Partial<GetCompanyTicketRevenuePerAirline>) { super(init); (Object as any).assign(this, init); }
}

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