Agentivity API

<back to all web services

GetCompanyTicketRevenuePerAirline

The following routes are available for this service:
GET/AirlineTicketRevenues
import 'package:servicestack/servicestack.dart';

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

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

    /**
    * 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")
    int? TotalRecords;

    /**
    * 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")
    int? ResponseRecords;

    PagingMetadata({this.Offset,this.Limit,this.TotalRecords,this.ResponseRecords});
    PagingMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Limit = json['Limit'];
        TotalRecords = json['TotalRecords'];
        ResponseRecords = json['ResponseRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Limit': Limit,
        'TotalRecords': TotalRecords,
        'ResponseRecords': ResponseRecords
    };

    getTypeName() => "PagingMetadata";
    TypeContext? context = _ctx;
}

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

    // @DataMember(Order=20)
    String? AirlineShortName;

    // @DataMember(Order=30)
    double? TotalFares;

    // @DataMember(Order=40)
    double? TotalTax;

    // @DataMember(Order=50)
    double? TotalBaseRevenue;

    // @DataMember(Order=60)
    String? FormattedCarrierPlatingName;

    // @DataMember(Order=70)
    String? PrintedCurrency;

    // @DataMember(Order=80)
    String? FormattedTotalFares;

    // @DataMember(Order=90)
    String? FormattedTotalTax;

    // @DataMember(Order=100)
    String? FormattedTotalBaseRevenue;

    AirlineTicketRevenue({this.PlatingCarrier,this.AirlineShortName,this.TotalFares,this.TotalTax,this.TotalBaseRevenue,this.FormattedCarrierPlatingName,this.PrintedCurrency,this.FormattedTotalFares,this.FormattedTotalTax,this.FormattedTotalBaseRevenue});
    AirlineTicketRevenue.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PlatingCarrier = json['PlatingCarrier'];
        AirlineShortName = json['AirlineShortName'];
        TotalFares = JsonConverters.toDouble(json['TotalFares']);
        TotalTax = JsonConverters.toDouble(json['TotalTax']);
        TotalBaseRevenue = JsonConverters.toDouble(json['TotalBaseRevenue']);
        FormattedCarrierPlatingName = json['FormattedCarrierPlatingName'];
        PrintedCurrency = json['PrintedCurrency'];
        FormattedTotalFares = json['FormattedTotalFares'];
        FormattedTotalTax = json['FormattedTotalTax'];
        FormattedTotalBaseRevenue = json['FormattedTotalBaseRevenue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PlatingCarrier': PlatingCarrier,
        'AirlineShortName': AirlineShortName,
        'TotalFares': TotalFares,
        'TotalTax': TotalTax,
        'TotalBaseRevenue': TotalBaseRevenue,
        'FormattedCarrierPlatingName': FormattedCarrierPlatingName,
        'PrintedCurrency': PrintedCurrency,
        'FormattedTotalFares': FormattedTotalFares,
        'FormattedTotalTax': FormattedTotalTax,
        'FormattedTotalBaseRevenue': FormattedTotalBaseRevenue
    };

    getTypeName() => "AirlineTicketRevenue";
    TypeContext? context = _ctx;
}

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

    Report({this.Item});
    Report.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Item = JsonConverters.fromJson(json['Item'],'TItem',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Item': JsonConverters.toJson(Item,'TItem',context!)
    };

    getTypeName() => "Report<$TItemResponse,$TItem>";
    TypeContext? context = _ctx;
}

// @DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
class AirlineTicketRevenuesResponseReport extends Report<AirlineTicketRevenuesItemResponse,AirlineTicketRevenue> implements IConvertible
{
    AirlineTicketRevenuesResponseReport();
    AirlineTicketRevenuesResponseReport.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "AirlineTicketRevenuesResponseReport";
    TypeContext? context = _ctx;
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
class CacheMetadata implements IConvertible
{
    // @DataMember(Order=1)
    DateTime? CachedAt;

    // @DataMember(Order=2)
    DateTime? CacheExpiresAt;

    // @DataMember(Order=0)
    bool? IsFromCache;

    CacheMetadata({this.CachedAt,this.CacheExpiresAt,this.IsFromCache});
    CacheMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CachedAt = JsonConverters.fromJson(json['CachedAt'],'DateTime',context!);
        CacheExpiresAt = JsonConverters.fromJson(json['CacheExpiresAt'],'DateTime',context!);
        IsFromCache = json['IsFromCache'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CachedAt': JsonConverters.toJson(CachedAt,'DateTime',context!),
        'CacheExpiresAt': JsonConverters.toJson(CacheExpiresAt,'DateTime',context!),
        'IsFromCache': IsFromCache
    };

    getTypeName() => "CacheMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class ResponseMetadata implements IConvertible
{
    // @DataMember(Order=0)
    bool? Success;

    // @DataMember(Order=1)
    bool? HasCache;

    // @DataMember(Order=2)
    bool? HasPaging;

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

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

    ResponseMetadata({this.Success,this.HasCache,this.HasPaging,this.CacheMetadata,this.PagingMetadata});
    ResponseMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        HasCache = json['HasCache'];
        HasPaging = json['HasPaging'];
        CacheMetadata = JsonConverters.fromJson(json['CacheMetadata'],'CacheMetadata',context!);
        PagingMetadata = JsonConverters.fromJson(json['PagingMetadata'],'PagingMetadata',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'HasCache': HasCache,
        'HasPaging': HasPaging,
        'CacheMetadata': JsonConverters.toJson(CacheMetadata,'CacheMetadata',context!),
        'PagingMetadata': JsonConverters.toJson(PagingMetadata,'PagingMetadata',context!)
    };

    getTypeName() => "ResponseMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class AgentivityError implements IConvertible
{
    // @DataMember
    String? ErrorCode;

    // @DataMember
    String? Message;

    // @DataMember
    String? StatusCode;

    // @DataMember
    String? VerboseMessage;

    AgentivityError({this.ErrorCode,this.Message,this.StatusCode,this.VerboseMessage});
    AgentivityError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ErrorCode = json['ErrorCode'];
        Message = json['Message'];
        StatusCode = json['StatusCode'];
        VerboseMessage = json['VerboseMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ErrorCode': ErrorCode,
        'Message': Message,
        'StatusCode': StatusCode,
        'VerboseMessage': VerboseMessage
    };

    getTypeName() => "AgentivityError";
    TypeContext? context = _ctx;
}

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

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

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

    ItemResponse({this.ResponseMetadata,this.ResponseReport,this.ResponseError});
    ItemResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseMetadata = JsonConverters.fromJson(json['ResponseMetadata'],'ResponseMetadata',context!);
        ResponseReport = JsonConverters.fromJson(json['ResponseReport'],'TReport',context!);
        ResponseError = JsonConverters.fromJson(json['ResponseError'],'AgentivityError',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseMetadata': JsonConverters.toJson(ResponseMetadata,'ResponseMetadata',context!),
        'ResponseReport': JsonConverters.toJson(ResponseReport,'TReport',context!),
        'ResponseError': JsonConverters.toJson(ResponseError,'AgentivityError',context!)
    };

    getTypeName() => "ItemResponse<$TItem,$TReport>";
    TypeContext? context = _ctx;
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class AirlineTicketRevenuesItemResponse extends ItemResponse<AirlineTicketRevenue,AirlineTicketRevenuesResponseReport> implements IConvertible
{
    AirlineTicketRevenuesItemResponse();
    AirlineTicketRevenuesItemResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "AirlineTicketRevenuesItemResponse";
    TypeContext? context = _ctx;
}

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

    /**
    * Code for Plating Carrier
    */
    // @DataMember
    String? PlatingCarrier;

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? DepartureDateStart;

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? DepartureDateEnd;

    /**
    * One letter code for flight coupon status
    */
    // @DataMember
    String? FlightCouponStatus;

    /**
    * UserName in form of an email address
    */
    // @DataMember
    String? UserName;

    /**
    * Two letter airline code
    */
    // @DataMember
    String? AirlineCode;

    GetCompanyTicketRevenuePerAirline({this.TravelAgentID,this.PlatingCarrier,this.DepartureDateStart,this.DepartureDateEnd,this.FlightCouponStatus,this.UserName,this.AirlineCode});
    GetCompanyTicketRevenuePerAirline.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        TravelAgentID = json['TravelAgentID'];
        PlatingCarrier = json['PlatingCarrier'];
        DepartureDateStart = json['DepartureDateStart'];
        DepartureDateEnd = json['DepartureDateEnd'];
        FlightCouponStatus = json['FlightCouponStatus'];
        UserName = json['UserName'];
        AirlineCode = json['AirlineCode'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'TravelAgentID': TravelAgentID,
        'PlatingCarrier': PlatingCarrier,
        'DepartureDateStart': DepartureDateStart,
        'DepartureDateEnd': DepartureDateEnd,
        'FlightCouponStatus': FlightCouponStatus,
        'UserName': UserName,
        'AirlineCode': AirlineCode
    });

    getTypeName() => "GetCompanyTicketRevenuePerAirline";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'AirlineTicketRevenue': TypeInfo(TypeOf.Class, create:() => AirlineTicketRevenue()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'AirlineTicketRevenuesResponseReport': TypeInfo(TypeOf.Class, create:() => AirlineTicketRevenuesResponseReport()),
    'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
    'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
    'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
    'ItemResponse<TItem,TReport>': TypeInfo(TypeOf.GenericDef,create:() => ItemResponse()),
    'AirlineTicketRevenuesItemResponse': TypeInfo(TypeOf.Class, create:() => AirlineTicketRevenuesItemResponse()),
    'GetCompanyTicketRevenuePerAirline': TypeInfo(TypeOf.Class, create:() => GetCompanyTicketRevenuePerAirline()),
});

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