Agentivity API

<back to all web services

GetPassengerLocationsByAirline

The following routes are available for this service:
GET/PassengerLocationsByAirlineCityDepreciated, do not use
GET/PassengerLocationsByAirline
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(Namespace="schemas.agentivity.com/types")
abstract class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    // @DataMember
    List<String>? OwningCompanyCode;

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

    CompanyLevelRequestBase({this.OwningCompanyCode,this.UserName});
    CompanyLevelRequestBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'OwningCompanyCode': JsonConverters.toJson(OwningCompanyCode,'List<String>',context!),
        'UserName': UserName
    });

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

// @DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")
class CustomFieldData implements IConvertible
{
    // @DataMember(Order=20)
    String? FieldName;

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

    CustomFieldData({this.FieldName,this.FieldValue});
    CustomFieldData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FieldName = json['FieldName'];
        FieldValue = json['FieldValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FieldName': FieldName,
        'FieldValue': FieldValue
    };

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

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

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

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

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

    BookingExtVendorLocator({this.CarrierCode,this.VendorLocator});
    BookingExtVendorLocator.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CarrierCode = json['CarrierCode'];
        VendorLocator = json['VendorLocator'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CarrierCode': CarrierCode,
        'VendorLocator': VendorLocator
    };

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

// @DataContract(Name="PassengerLocationAirline", Namespace="schemas.agentivity.com/types")
class PassengerLocationAirline implements IBookingCustomFields, IBookingIdentifier, ITicketNumbers, IVendorLocators, IConvertible
{
    // @DataMember(Order=10)
    int? AgentivityRef;

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

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

    // @DataMember(Order=40)
    DateTime? TravelDate;

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

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

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

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

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

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

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

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

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

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

    // @DataMember(Order=150)
    String? PhoneNbr;

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

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

    // @DataMember(Order=180)
    CustomFieldsCollection? CustomFields;

    // @DataMember(Order=190)
    DateTime? DepartureDateTime;

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

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

    // @DataMember(Order=220)
    List<String>? TicketNumbers;

    // @DataMember(Order=230)
    List<BookingExtVendorLocator>? VendorLocators;

    PassengerLocationAirline({this.AgentivityRef,this.RecordLocator,this.OwningConsultantID,this.TravelDate,this.PnrTicketed,this.PaxList,this.Account,this.DestinationCities,this.Connections,this.CarrierCodes,this.OperatingCarrierCodes,this.BoardPoint,this.FlightNumbers,this.EmailAddress,this.PhoneNbr,this.OwningAgencyLocationID,this.IataCodes,this.CustomFields,this.DepartureDateTime,this.SegmentType,this.PNRCreationDate,this.TicketNumbers,this.VendorLocators});
    PassengerLocationAirline.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentivityRef = json['AgentivityRef'];
        RecordLocator = json['RecordLocator'];
        OwningConsultantID = json['OwningConsultantID'];
        TravelDate = JsonConverters.fromJson(json['TravelDate'],'DateTime',context!);
        PnrTicketed = json['PnrTicketed'];
        PaxList = json['PaxList'];
        Account = json['Account'];
        DestinationCities = json['DestinationCities'];
        Connections = json['Connections'];
        CarrierCodes = json['CarrierCodes'];
        OperatingCarrierCodes = json['OperatingCarrierCodes'];
        BoardPoint = json['BoardPoint'];
        FlightNumbers = json['FlightNumbers'];
        EmailAddress = json['EmailAddress'];
        PhoneNbr = json['PhoneNbr'];
        OwningAgencyLocationID = json['OwningAgencyLocationID'];
        IataCodes = json['IataCodes'];
        CustomFields = JsonConverters.fromJson(json['CustomFields'],'CustomFieldsCollection',context!);
        DepartureDateTime = JsonConverters.fromJson(json['DepartureDateTime'],'DateTime',context!);
        SegmentType = json['SegmentType'];
        PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
        TicketNumbers = JsonConverters.fromJson(json['TicketNumbers'],'List<String>',context!);
        VendorLocators = JsonConverters.fromJson(json['VendorLocators'],'List<BookingExtVendorLocator>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentivityRef': AgentivityRef,
        'RecordLocator': RecordLocator,
        'OwningConsultantID': OwningConsultantID,
        'TravelDate': JsonConverters.toJson(TravelDate,'DateTime',context!),
        'PnrTicketed': PnrTicketed,
        'PaxList': PaxList,
        'Account': Account,
        'DestinationCities': DestinationCities,
        'Connections': Connections,
        'CarrierCodes': CarrierCodes,
        'OperatingCarrierCodes': OperatingCarrierCodes,
        'BoardPoint': BoardPoint,
        'FlightNumbers': FlightNumbers,
        'EmailAddress': EmailAddress,
        'PhoneNbr': PhoneNbr,
        'OwningAgencyLocationID': OwningAgencyLocationID,
        'IataCodes': IataCodes,
        'CustomFields': JsonConverters.toJson(CustomFields,'CustomFieldsCollection',context!),
        'DepartureDateTime': JsonConverters.toJson(DepartureDateTime,'DateTime',context!),
        'SegmentType': SegmentType,
        'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
        'TicketNumbers': JsonConverters.toJson(TicketNumbers,'List<String>',context!),
        'VendorLocators': JsonConverters.toJson(VendorLocators,'List<BookingExtVendorLocator>',context!)
    };

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

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetPassengerLocationsByAirline extends CompanyLevelRequestBase implements IConvertible
{
    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    List<String>? Account;

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

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

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

    /**
    * 3 letter city code
    */
    // @DataMember
    String? CityCode;

    /**
    * Search operating vendor
    */
    // @DataMember
    bool? SearchOperatingVendor;

    /**
    * Comma Delimited List of Custom Fields
    */
    // @DataMember
    List<String>? CustomField;

    GetPassengerLocationsByAirline({this.Account,this.DateStart,this.DateEnd,this.CarrierCode,this.CityCode,this.SearchOperatingVendor,this.CustomField});
    GetPassengerLocationsByAirline.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Account = JsonConverters.fromJson(json['Account'],'List<String>',context!);
        DateStart = json['DateStart'];
        DateEnd = json['DateEnd'];
        CarrierCode = json['CarrierCode'];
        CityCode = json['CityCode'];
        SearchOperatingVendor = json['SearchOperatingVendor'];
        CustomField = JsonConverters.fromJson(json['CustomField'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Account': JsonConverters.toJson(Account,'List<String>',context!),
        'DateStart': DateStart,
        'DateEnd': DateEnd,
        'CarrierCode': CarrierCode,
        'CityCode': CityCode,
        'SearchOperatingVendor': SearchOperatingVendor,
        'CustomField': JsonConverters.toJson(CustomField,'List<String>',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'CustomFieldData': TypeInfo(TypeOf.Class, create:() => CustomFieldData()),
    'CustomFieldsCollection': TypeInfo(TypeOf.Class, create:() => CustomFieldsCollection()),
    'BookingExtVendorLocator': TypeInfo(TypeOf.Class, create:() => BookingExtVendorLocator()),
    'PassengerLocationAirline': TypeInfo(TypeOf.Class, create:() => PassengerLocationAirline()),
    'List<BookingExtVendorLocator>': TypeInfo(TypeOf.Class, create:() => <BookingExtVendorLocator>[]),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'PassengerLocationsByAirlineResponseReport': TypeInfo(TypeOf.Class, create:() => PassengerLocationsByAirlineResponseReport()),
    '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()),
    'PassengerLocationsByAirlineItemResponse': TypeInfo(TypeOf.Class, create:() => PassengerLocationsByAirlineItemResponse()),
    'GetPassengerLocationsByAirline': TypeInfo(TypeOf.Class, create:() => GetPassengerLocationsByAirline()),
});

Dart GetPassengerLocationsByAirline 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 /PassengerLocationsByAirlineCity 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":{"AgentivityRef":0,"RecordLocator":"String","OwningConsultantID":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PnrTicketed":"String","PaxList":"String","Account":"String","DestinationCities":"String","Connections":"String","CarrierCodes":"String","OperatingCarrierCodes":"String","BoardPoint":"String","FlightNumbers":"String","EmailAddress":"String","PhoneNbr":"String","OwningAgencyLocationID":"String","IataCodes":"String","CustomFields":[{"FieldName":"String","FieldValue":"String"}],"DepartureDateTime":"\/Date(-62135596800000-0000)\/","SegmentType":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TicketNumbers":["String"],"VendorLocators":[{"CarrierCode":"String","VendorLocator":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}