Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

The following routes are available for this service:
GET/AirlineTicketRevenues
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

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

        /**
        * Code for Plating Carrier
        */
        @DataMember
        public String PlatingCarrier = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String DepartureDateStart = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String DepartureDateEnd = null;

        /**
        * One letter code for flight coupon status
        */
        @DataMember
        public String FlightCouponStatus = null;

        /**
        * UserName in form of an email address
        */
        @DataMember
        public String UserName = null;

        /**
        * Two letter airline code
        */
        @DataMember
        public String AirlineCode = null;
        
        public String getTravelAgentID() { return TravelAgentID; }
        public GetCompanyTicketRevenuePerAirline setTravelAgentID(String value) { this.TravelAgentID = value; return this; }
        public String getPlatingCarrier() { return PlatingCarrier; }
        public GetCompanyTicketRevenuePerAirline setPlatingCarrier(String value) { this.PlatingCarrier = value; return this; }
        public String getDepartureDateStart() { return DepartureDateStart; }
        public GetCompanyTicketRevenuePerAirline setDepartureDateStart(String value) { this.DepartureDateStart = value; return this; }
        public String getDepartureDateEnd() { return DepartureDateEnd; }
        public GetCompanyTicketRevenuePerAirline setDepartureDateEnd(String value) { this.DepartureDateEnd = value; return this; }
        public String getFlightCouponStatus() { return FlightCouponStatus; }
        public GetCompanyTicketRevenuePerAirline setFlightCouponStatus(String value) { this.FlightCouponStatus = value; return this; }
        public String getUserName() { return UserName; }
        public GetCompanyTicketRevenuePerAirline setUserName(String value) { this.UserName = value; return this; }
        public String getAirlineCode() { return AirlineCode; }
        public GetCompanyTicketRevenuePerAirline setAirlineCode(String value) { this.AirlineCode = value; return this; }
    }

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

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

        /**
        * 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 Integer TotalRecords = null;

        /**
        * 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 Integer ResponseRecords = null;
        
        public String getOffset() { return Offset; }
        public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
        public String getLimit() { return Limit; }
        public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
        public Integer getTotalRecords() { return TotalRecords; }
        public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
        public Integer getResponseRecords() { return ResponseRecords; }
        public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
    }

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

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

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

        @DataMember(Order=3, EmitDefaultValue=false)
        public AgentivityError ResponseError = null;
        
        public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
        public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
        public TReport getResponseReport() { return ResponseReport; }
        public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
        public AgentivityError getResponseError() { return ResponseError; }
        public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
    }

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

        @DataMember(Order=1)
        public Boolean HasCache = null;

        @DataMember(Order=2)
        public Boolean HasPaging = null;

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

        @DataMember(Order=4, EmitDefaultValue=false)
        public PagingMetadata PagingMetadata = null;
        
        public Boolean isSuccess() { return Success; }
        public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
        public Boolean isHasCache() { return HasCache; }
        public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
        public Boolean isHasPaging() { return HasPaging; }
        public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
        public CacheMetadata getCacheMetadata() { return CacheMetadata; }
        public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
        public PagingMetadata getPagingMetadata() { return PagingMetadata; }
        public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
    }

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

        @DataMember(Order=2)
        public Date CacheExpiresAt = null;

        @DataMember(Order=0)
        public Boolean IsFromCache = null;
        
        public Date getCachedAt() { return CachedAt; }
        public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
        public Date getCacheExpiresAt() { return CacheExpiresAt; }
        public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
        public Boolean getIsFromCache() { return IsFromCache; }
        public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class AgentivityError
    {
        @DataMember
        public String ErrorCode = null;

        @DataMember
        public String Message = null;

        @DataMember
        public String StatusCode = null;

        @DataMember
        public String VerboseMessage = null;
        
        public String getErrorCode() { return ErrorCode; }
        public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public AgentivityError setMessage(String value) { this.Message = value; return this; }
        public String getStatusCode() { return StatusCode; }
        public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getVerboseMessage() { return VerboseMessage; }
        public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
    }

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

        @DataMember(Order=20)
        public String AirlineShortName = null;

        @DataMember(Order=30)
        public BigDecimal TotalFares = null;

        @DataMember(Order=40)
        public BigDecimal TotalTax = null;

        @DataMember(Order=50)
        public BigDecimal TotalBaseRevenue = null;

        @DataMember(Order=60)
        public String FormattedCarrierPlatingName = null;

        @DataMember(Order=70)
        public String PrintedCurrency = null;

        @DataMember(Order=80)
        public String FormattedTotalFares = null;

        @DataMember(Order=90)
        public String FormattedTotalTax = null;

        @DataMember(Order=100)
        public String FormattedTotalBaseRevenue = null;
        
        public String getPlatingCarrier() { return PlatingCarrier; }
        public AirlineTicketRevenue setPlatingCarrier(String value) { this.PlatingCarrier = value; return this; }
        public String getAirlineShortName() { return AirlineShortName; }
        public AirlineTicketRevenue setAirlineShortName(String value) { this.AirlineShortName = value; return this; }
        public BigDecimal getTotalFares() { return TotalFares; }
        public AirlineTicketRevenue setTotalFares(BigDecimal value) { this.TotalFares = value; return this; }
        public BigDecimal getTotalTax() { return TotalTax; }
        public AirlineTicketRevenue setTotalTax(BigDecimal value) { this.TotalTax = value; return this; }
        public BigDecimal getTotalBaseRevenue() { return TotalBaseRevenue; }
        public AirlineTicketRevenue setTotalBaseRevenue(BigDecimal value) { this.TotalBaseRevenue = value; return this; }
        public String getFormattedCarrierPlatingName() { return FormattedCarrierPlatingName; }
        public AirlineTicketRevenue setFormattedCarrierPlatingName(String value) { this.FormattedCarrierPlatingName = value; return this; }
        public String getPrintedCurrency() { return PrintedCurrency; }
        public AirlineTicketRevenue setPrintedCurrency(String value) { this.PrintedCurrency = value; return this; }
        public String getFormattedTotalFares() { return FormattedTotalFares; }
        public AirlineTicketRevenue setFormattedTotalFares(String value) { this.FormattedTotalFares = value; return this; }
        public String getFormattedTotalTax() { return FormattedTotalTax; }
        public AirlineTicketRevenue setFormattedTotalTax(String value) { this.FormattedTotalTax = value; return this; }
        public String getFormattedTotalBaseRevenue() { return FormattedTotalBaseRevenue; }
        public AirlineTicketRevenue setFormattedTotalBaseRevenue(String value) { this.FormattedTotalBaseRevenue = value; return this; }
    }

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

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class Report<TItemResponse, TItem>
    {
        @DataMember(Order=1, EmitDefaultValue=false)
        public TItem Item = null;
        
        public TItem getItem() { return Item; }
        public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
    }

}

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