Agentivity API

<back to all web services

EventBookingsRequest

The following routes are available for this service:
GET/EventBookings
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="ItinerarySegment", Namespace="schemas.agentivity.com/types")
class ItinerarySegment implements IConvertible
{
    // @DataMember
    String? SegmentType;

    // @DataMember
    int? SegmentNbr;

    // @DataMember
    String? BoardPoint;

    // @DataMember
    String? OffPoint;

    // @DataMember
    String? OperatorCode;

    // @DataMember
    String? OperatorService;

    // @DataMember
    String? SegmentStatus;

    // @DataMember
    String? DepartureTimeFormatted;

    // @DataMember
    String? ArrivalTimeFormatted;

    // @DataMember
    String? ChangeOfDayFormatted;

    // @DataMember
    String? ServiceCode;

    // @DataMember
    String? StartDate;

    // @DataMember
    String? EndDate;

    // @DataMember
    String? TicketNumber;

    /**
    * Comma separated list of vendor locators
    */
    // @DataMember
    String? VendorLocators;

    // @DataMember
    String? EquipmentCode;

    // @DataMember
    String? Equipment;

    ItinerarySegment({this.SegmentType,this.SegmentNbr,this.BoardPoint,this.OffPoint,this.OperatorCode,this.OperatorService,this.SegmentStatus,this.DepartureTimeFormatted,this.ArrivalTimeFormatted,this.ChangeOfDayFormatted,this.ServiceCode,this.StartDate,this.EndDate,this.TicketNumber,this.VendorLocators,this.EquipmentCode,this.Equipment});
    ItinerarySegment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SegmentType = json['SegmentType'];
        SegmentNbr = json['SegmentNbr'];
        BoardPoint = json['BoardPoint'];
        OffPoint = json['OffPoint'];
        OperatorCode = json['OperatorCode'];
        OperatorService = json['OperatorService'];
        SegmentStatus = json['SegmentStatus'];
        DepartureTimeFormatted = json['DepartureTimeFormatted'];
        ArrivalTimeFormatted = json['ArrivalTimeFormatted'];
        ChangeOfDayFormatted = json['ChangeOfDayFormatted'];
        ServiceCode = json['ServiceCode'];
        StartDate = json['StartDate'];
        EndDate = json['EndDate'];
        TicketNumber = json['TicketNumber'];
        VendorLocators = json['VendorLocators'];
        EquipmentCode = json['EquipmentCode'];
        Equipment = json['Equipment'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SegmentType': SegmentType,
        'SegmentNbr': SegmentNbr,
        'BoardPoint': BoardPoint,
        'OffPoint': OffPoint,
        'OperatorCode': OperatorCode,
        'OperatorService': OperatorService,
        'SegmentStatus': SegmentStatus,
        'DepartureTimeFormatted': DepartureTimeFormatted,
        'ArrivalTimeFormatted': ArrivalTimeFormatted,
        'ChangeOfDayFormatted': ChangeOfDayFormatted,
        'ServiceCode': ServiceCode,
        'StartDate': StartDate,
        'EndDate': EndDate,
        'TicketNumber': TicketNumber,
        'VendorLocators': VendorLocators,
        'EquipmentCode': EquipmentCode,
        'Equipment': Equipment
    };

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

class ItinerarySegmentsCollection extends ListBase<ItinerarySegment> implements IConvertible
{
    final List<ItinerarySegment> l = [];
    set length(int newLength) { l.length = newLength; }
    int get length => l.length;
    ItinerarySegment operator [](int index) => l[index];
    void operator []=(int index, ItinerarySegment value) { l[index] = value; }
    ItinerarySegmentsCollection();
    ItinerarySegmentsCollection.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ItinerarySegmentsCollection";
    TypeContext? context = _ctx;
}

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

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

    // @DataMember(Order=30)
    String? PaxList;

    // @DataMember(Order=35)
    int? PaxCount;

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

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

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

    // @DataMember(Order=100)
    DateTime? InboundArrivalDate;

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

    // @DataMember(Order=120)
    String? OutboundAirline;

    // @DataMember(Order=130)
    String? OutboundFlightNumber;

    // @DataMember(Order=140)
    String? OutboundDepartureCity;

    // @DataMember(Order=150)
    DateTime? OutboundDepartureDate;

    // @DataMember(Order=160)
    String? OutboundDepartureTime;

    // @DataMember(Order=170)
    String? Notes;

    // @DataMember(Order=180)
    String? Emails;

    // @DataMember(Order=190)
    String? Mobile;

    // @DataMember(Order=200)
    String? TotalTicketedValue;

    // @DataMember(Order=40)
    int? AgentivityRef;

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

    // @DataMember(Order=60)
    ItinerarySegmentsCollection? Itinerary;

    EventBooking({this.RecordLocator,this.PNRCreationDate,this.PaxList,this.PaxCount,this.InboundAirline,this.InboundFlightNumber,this.InboundArrivalCity,this.InboundArrivalDate,this.InboundArrivalTime,this.OutboundAirline,this.OutboundFlightNumber,this.OutboundDepartureCity,this.OutboundDepartureDate,this.OutboundDepartureTime,this.Notes,this.Emails,this.Mobile,this.TotalTicketedValue,this.AgentivityRef,this.ItineraryFormatted,this.Itinerary});
    EventBooking.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RecordLocator = json['RecordLocator'];
        PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
        PaxList = json['PaxList'];
        PaxCount = json['PaxCount'];
        InboundAirline = json['InboundAirline'];
        InboundFlightNumber = json['InboundFlightNumber'];
        InboundArrivalCity = json['InboundArrivalCity'];
        InboundArrivalDate = JsonConverters.fromJson(json['InboundArrivalDate'],'DateTime',context!);
        InboundArrivalTime = json['InboundArrivalTime'];
        OutboundAirline = json['OutboundAirline'];
        OutboundFlightNumber = json['OutboundFlightNumber'];
        OutboundDepartureCity = json['OutboundDepartureCity'];
        OutboundDepartureDate = JsonConverters.fromJson(json['OutboundDepartureDate'],'DateTime',context!);
        OutboundDepartureTime = json['OutboundDepartureTime'];
        Notes = json['Notes'];
        Emails = json['Emails'];
        Mobile = json['Mobile'];
        TotalTicketedValue = json['TotalTicketedValue'];
        AgentivityRef = json['AgentivityRef'];
        ItineraryFormatted = json['ItineraryFormatted'];
        Itinerary = JsonConverters.fromJson(json['Itinerary'],'ItinerarySegmentsCollection',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RecordLocator': RecordLocator,
        'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
        'PaxList': PaxList,
        'PaxCount': PaxCount,
        'InboundAirline': InboundAirline,
        'InboundFlightNumber': InboundFlightNumber,
        'InboundArrivalCity': InboundArrivalCity,
        'InboundArrivalDate': JsonConverters.toJson(InboundArrivalDate,'DateTime',context!),
        'InboundArrivalTime': InboundArrivalTime,
        'OutboundAirline': OutboundAirline,
        'OutboundFlightNumber': OutboundFlightNumber,
        'OutboundDepartureCity': OutboundDepartureCity,
        'OutboundDepartureDate': JsonConverters.toJson(OutboundDepartureDate,'DateTime',context!),
        'OutboundDepartureTime': OutboundDepartureTime,
        'Notes': Notes,
        'Emails': Emails,
        'Mobile': Mobile,
        'TotalTicketedValue': TotalTicketedValue,
        'AgentivityRef': AgentivityRef,
        'ItineraryFormatted': ItineraryFormatted,
        'Itinerary': JsonConverters.toJson(Itinerary,'ItinerarySegmentsCollection',context!)
    };

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

// @DataContract(Namespace="schemas.agentivity.com/types")
class EventBookingsRequest extends PagingMetadata implements IConvertible
{
    /**
    * UserName in form of an email address
    */
    // @DataMember
    String? UserName;

    /**
    * Event code
    */
    // @DataMember
    String? EventCode;

    /**
    * Split multiple passengers
    */
    // @DataMember
    bool? SplitMultiplePassengers;

    /**
    * Include notes in the response
    */
    // @DataMember
    bool? IncludeNotes;

    /**
    * Include arrival departures
    */
    // @DataMember
    bool? IncludeArrivalDepartures;

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

    /**
    * Itinerary segments to show
    */
    // @DataMember
    String? ItinerarySegmentsToShow;

    EventBookingsRequest({this.UserName,this.EventCode,this.SplitMultiplePassengers,this.IncludeNotes,this.IncludeArrivalDepartures,this.FormattingStyle,this.ItinerarySegmentsToShow});
    EventBookingsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        UserName = json['UserName'];
        EventCode = json['EventCode'];
        SplitMultiplePassengers = json['SplitMultiplePassengers'];
        IncludeNotes = json['IncludeNotes'];
        IncludeArrivalDepartures = json['IncludeArrivalDepartures'];
        FormattingStyle = json['FormattingStyle'];
        ItinerarySegmentsToShow = json['ItinerarySegmentsToShow'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'UserName': UserName,
        'EventCode': EventCode,
        'SplitMultiplePassengers': SplitMultiplePassengers,
        'IncludeNotes': IncludeNotes,
        'IncludeArrivalDepartures': IncludeArrivalDepartures,
        'FormattingStyle': FormattingStyle,
        'ItinerarySegmentsToShow': ItinerarySegmentsToShow
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'ItinerarySegment': TypeInfo(TypeOf.Class, create:() => ItinerarySegment()),
    'ItinerarySegmentsCollection': TypeInfo(TypeOf.Class, create:() => ItinerarySegmentsCollection()),
    'EventBooking': TypeInfo(TypeOf.Class, create:() => EventBooking()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'EventBookingsResponseReport': TypeInfo(TypeOf.Class, create:() => EventBookingsResponseReport()),
    '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()),
    'EventBookingsItemResponse': TypeInfo(TypeOf.Class, create:() => EventBookingsItemResponse()),
    'EventBookingsRequest': TypeInfo(TypeOf.Class, create:() => EventBookingsRequest()),
});

Dart EventBookingsRequest 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 /EventBookings 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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PaxList":"String","PaxCount":0,"AgentivityRef":0,"ItineraryFormatted":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"InboundAirline":"String","InboundFlightNumber":"String","InboundArrivalCity":"String","InboundArrivalDate":"\/Date(-62135596800000-0000)\/","InboundArrivalTime":"String","OutboundAirline":"String","OutboundFlightNumber":"String","OutboundDepartureCity":"String","OutboundDepartureDate":"\/Date(-62135596800000-0000)\/","OutboundDepartureTime":"String","Notes":"String","Emails":"String","Mobile":"String","TotalTicketedValue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}