Agentivity API

<back to all web services

GetDistributorBookingsTravellingByAirlineClass

The following routes are available for this service:
GET/DistributorBookingsByAirlineClass
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="BookingByAirlineWithClassSupport", Namespace="schemas.agentivity.com/types")
class BookingByAirlineWithClassSupport implements IConvertible
{
    // @DataMember(Order=10)
    int? AgentivityRef;

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

    // @DataMember(Order=30)
    DateTime? PNRCreationDate;

    // @DataMember(Order=40)
    String? Account;

    // @DataMember(Order=50)
    String? OwningConsultant;

    // @DataMember(Order=55)
    String? TicketedStatusCode;

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

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

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

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

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

    // @DataMember(Order=110)
    String? TktTourCode;

    BookingByAirlineWithClassSupport({this.AgentivityRef,this.RecordLocator,this.PNRCreationDate,this.Account,this.OwningConsultant,this.TicketedStatusCode,this.TicketedStatus,this.BookingCodesBooked,this.FlightNumbers,this.Routing,this.TrackingCode,this.TktTourCode});
    BookingByAirlineWithClassSupport.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentivityRef = json['AgentivityRef'];
        RecordLocator = json['RecordLocator'];
        PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
        Account = json['Account'];
        OwningConsultant = json['OwningConsultant'];
        TicketedStatusCode = json['TicketedStatusCode'];
        TicketedStatus = json['TicketedStatus'];
        BookingCodesBooked = json['BookingCodesBooked'];
        FlightNumbers = json['FlightNumbers'];
        Routing = json['Routing'];
        TrackingCode = json['TrackingCode'];
        TktTourCode = json['TktTourCode'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentivityRef': AgentivityRef,
        'RecordLocator': RecordLocator,
        'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
        'Account': Account,
        'OwningConsultant': OwningConsultant,
        'TicketedStatusCode': TicketedStatusCode,
        'TicketedStatus': TicketedStatus,
        'BookingCodesBooked': BookingCodesBooked,
        'FlightNumbers': FlightNumbers,
        'Routing': Routing,
        'TrackingCode': TrackingCode,
        'TktTourCode': TktTourCode
    };

    getTypeName() => "BookingByAirlineWithClassSupport";
    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 BookingsByAirlineWithClassSupportItemResponse extends ItemResponse<BookingByAirlineWithClassSupport,BookingsByAirlineWithClassSupportResponseReport> implements IConvertible
{
    BookingsByAirlineWithClassSupportItemResponse();
    BookingsByAirlineWithClassSupportItemResponse.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() => "BookingsByAirlineWithClassSupportItemResponse";
    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="BookingByAirlineWithClassSupport", Namespace="schemas.agentivity.com/types")
class BookingsByAirlineWithClassSupportResponseReport extends Report<BookingsByAirlineWithClassSupportItemResponse,BookingByAirlineWithClassSupport> implements IConvertible
{
    BookingsByAirlineWithClassSupportResponseReport();
    BookingsByAirlineWithClassSupportResponseReport.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() => "BookingsByAirlineWithClassSupportResponseReport";
    TypeContext? context = _ctx;
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class DistributorBookingsByAirlineClassItemResponse extends ItemResponse<BookingByAirlineWithClassSupport,BookingsByAirlineWithClassSupportResponseReport> implements IConvertible
{
    DistributorBookingsByAirlineClassItemResponse();
    DistributorBookingsByAirlineClassItemResponse.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() => "DistributorBookingsByAirlineClassItemResponse";
    TypeContext? context = _ctx;
}

// @Flags()
class FormattingStyle
{
    static const FormattingStyle None = const FormattingStyle._(0);
    static const FormattingStyle Html = const FormattingStyle._(1);
    static const FormattingStyle Charting = const FormattingStyle._(2);

    final int _value;
    const FormattingStyle._(this._value);
    int get value => _value;
    static List<FormattingStyle> get values => const [None,Html,Charting];
}

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetDistributorBookingsTravellingByAirlineClass extends PagingMetadata implements IConvertible
{
    /**
    * ID of Distributor
    */
    // @DataMember
    int? DistributorID;

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

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

    /**
    * Two letter code for carrier
    */
    // @DataMember
    String? PlatingCarrier;

    /**
    * Booking Class Name
    */
    // @DataMember
    String? BookingClassName;

    /**
    * BoardPoint CountryCode
    */
    // @DataMember
    String? BoardPointCountryCode;

    /**
    * Include Itinerary in the response
    */
    // @DataMember
    bool? IncludeItinerary;

    /**
    * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
    */
    // @DataMember
    FormattingStyle? ItineraryFormatting;

    GetDistributorBookingsTravellingByAirlineClass({this.DistributorID,this.IssueDateStart,this.IssueDateEnd,this.PlatingCarrier,this.BookingClassName,this.BoardPointCountryCode,this.IncludeItinerary,this.ItineraryFormatting});
    GetDistributorBookingsTravellingByAirlineClass.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        DistributorID = json['DistributorID'];
        IssueDateStart = json['IssueDateStart'];
        IssueDateEnd = json['IssueDateEnd'];
        PlatingCarrier = json['PlatingCarrier'];
        BookingClassName = json['BookingClassName'];
        BoardPointCountryCode = json['BoardPointCountryCode'];
        IncludeItinerary = json['IncludeItinerary'];
        ItineraryFormatting = JsonConverters.fromJson(json['ItineraryFormatting'],'FormattingStyle',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'DistributorID': DistributorID,
        'IssueDateStart': IssueDateStart,
        'IssueDateEnd': IssueDateEnd,
        'PlatingCarrier': PlatingCarrier,
        'BookingClassName': BookingClassName,
        'BoardPointCountryCode': BoardPointCountryCode,
        'IncludeItinerary': IncludeItinerary,
        'ItineraryFormatting': JsonConverters.toJson(ItineraryFormatting,'FormattingStyle',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'BookingByAirlineWithClassSupport': TypeInfo(TypeOf.Class, create:() => BookingByAirlineWithClassSupport()),
    '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()),
    'BookingsByAirlineWithClassSupportItemResponse': TypeInfo(TypeOf.Class, create:() => BookingsByAirlineWithClassSupportItemResponse()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'BookingsByAirlineWithClassSupportResponseReport': TypeInfo(TypeOf.Class, create:() => BookingsByAirlineWithClassSupportResponseReport()),
    'DistributorBookingsByAirlineClassItemResponse': TypeInfo(TypeOf.Class, create:() => DistributorBookingsByAirlineClassItemResponse()),
    'FormattingStyle': TypeInfo(TypeOf.Enum, enumValues:FormattingStyle.values),
    'GetDistributorBookingsTravellingByAirlineClass': TypeInfo(TypeOf.Class, create:() => GetDistributorBookingsTravellingByAirlineClass()),
});

Dart GetDistributorBookingsTravellingByAirlineClass 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 /DistributorBookingsByAirlineClass 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":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Account":"String","OwningConsultant":"String","TicketedStatusCode":"String","TicketedStatus":"String","BookingCodesBooked":"String","FlightNumbers":"String","Routing":"String","TrackingCode":"String","TktTourCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}