Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

The following routes are available for this service:
GET/AirlineTicketRevenues
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class ItemResponse<TItem, TReport>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual TReport ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Report<TItemResponse, TItem>
    {
        [DataMember(Order=1, EmitDefaultValue=false)]
        public virtual TItem Item { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    [DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")]
    public partial class AirlineTicketRevenue
    {
        [DataMember(Order=10)]
        public virtual string PlatingCarrier { get; set; }

        [DataMember(Order=20)]
        public virtual string AirlineShortName { get; set; }

        [DataMember(Order=30)]
        public virtual decimal? TotalFares { get; set; }

        [DataMember(Order=40)]
        public virtual decimal? TotalTax { get; set; }

        [DataMember(Order=50)]
        public virtual decimal? TotalBaseRevenue { get; set; }

        [DataMember(Order=60)]
        public virtual string FormattedCarrierPlatingName { get; set; }

        [DataMember(Order=70)]
        public virtual string PrintedCurrency { get; set; }

        [DataMember(Order=80)]
        public virtual string FormattedTotalFares { get; set; }

        [DataMember(Order=90)]
        public virtual string FormattedTotalTax { get; set; }

        [DataMember(Order=100)]
        public virtual string FormattedTotalBaseRevenue { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class AirlineTicketRevenuesItemResponse
        : ItemResponse<AirlineTicketRevenue, AirlineTicketRevenuesResponseReport>
    {
    }

    [DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")]
    public partial class AirlineTicketRevenuesResponseReport
        : Report<AirlineTicketRevenuesItemResponse, AirlineTicketRevenue>
    {
    }

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetCompanyTicketRevenuePerAirline
        : PagingMetadata
    {
        ///<summary>
        ///ID of a travel agent
        ///</summary>
        [DataMember]
        public virtual string TravelAgentID { get; set; }

        ///<summary>
        ///Code for Plating Carrier
        ///</summary>
        [DataMember]
        public virtual string PlatingCarrier { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DepartureDateStart { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string DepartureDateEnd { get; set; }

        ///<summary>
        ///One letter code for flight coupon status
        ///</summary>
        [DataMember]
        public virtual string FlightCouponStatus { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }

        ///<summary>
        ///Two letter airline code
        ///</summary>
        [DataMember]
        public virtual string AirlineCode { get; set; }
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")]
        public virtual int TotalRecords { get; set; }

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")]
        public virtual int ResponseRecords { get; set; }
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

}

C# GetCompanyTicketRevenuePerAirline 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 /AirlineTicketRevenues 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":{"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"}}