Agentivity API

<back to all web services

GetConsultantWorkActiveUnsoldAir

The following routes are available for this service:
All Verbs/ConsultantWorkActiveUnsoldAir
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="ActiveUnsoldAirBooking", Namespace="schemas.agentivity.com/types")
class ConsultantActiveUnsoldAirBooking implements IConvertible
{
    // @DataMember(Order=10)
    String? RecordLocator;

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

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

    // @DataMember(Order=35)
    String? GdsCode;

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

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

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

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

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

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

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

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

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

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

    ConsultantActiveUnsoldAirBooking({this.RecordLocator,this.PNRCreationDate,this.OwningAgencyLocationID,this.GdsCode,this.PrimaryPax,this.OwningConsultant,this.OwningConsultantID,this.Account,this.AgentivityRef,this.PrimaryCarrierCode,this.FiledFare,this.TravelDate,this.DestinationCities,this.BookingClasses});
    ConsultantActiveUnsoldAirBooking.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RecordLocator = json['RecordLocator'];
        PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
        OwningAgencyLocationID = json['OwningAgencyLocationID'];
        GdsCode = json['GdsCode'];
        PrimaryPax = json['PrimaryPax'];
        OwningConsultant = json['OwningConsultant'];
        OwningConsultantID = json['OwningConsultantID'];
        Account = json['Account'];
        AgentivityRef = json['AgentivityRef'];
        PrimaryCarrierCode = json['PrimaryCarrierCode'];
        FiledFare = json['FiledFare'];
        TravelDate = JsonConverters.fromJson(json['TravelDate'],'DateTime',context!);
        DestinationCities = json['DestinationCities'];
        BookingClasses = json['BookingClasses'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RecordLocator': RecordLocator,
        'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
        'OwningAgencyLocationID': OwningAgencyLocationID,
        'GdsCode': GdsCode,
        'PrimaryPax': PrimaryPax,
        'OwningConsultant': OwningConsultant,
        'OwningConsultantID': OwningConsultantID,
        'Account': Account,
        'AgentivityRef': AgentivityRef,
        'PrimaryCarrierCode': PrimaryCarrierCode,
        'FiledFare': FiledFare,
        'TravelDate': JsonConverters.toJson(TravelDate,'DateTime',context!),
        'DestinationCities': DestinationCities,
        'BookingClasses': BookingClasses
    };

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

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetConsultantWorkActiveUnsoldAir extends CompanyLevelRequestBase implements IRequestConsultantID, IConvertible
{
    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? DateStart;

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

    /**
    * Comma delimited list of owning consultants ids
    */
    // @DataMember
    List<String>? OwningConsultantID = [];

    /**
    * Comma delimited list of transaction agency location ids
    */
    // @DataMember
    List<String>? TransactionAgencyLocationID;

    /**
    * Request Consultant ID (sign on)
    */
    // @DataMember
    String? RequestConsultantID;

    GetConsultantWorkActiveUnsoldAir({this.DateStart,this.DateEnd,this.OwningConsultantID,this.TransactionAgencyLocationID,this.RequestConsultantID});
    GetConsultantWorkActiveUnsoldAir.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        DateStart = json['DateStart'];
        DateEnd = json['DateEnd'];
        OwningConsultantID = JsonConverters.fromJson(json['OwningConsultantID'],'List<String>',context!);
        TransactionAgencyLocationID = JsonConverters.fromJson(json['TransactionAgencyLocationID'],'List<String>',context!);
        RequestConsultantID = json['RequestConsultantID'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'DateStart': DateStart,
        'DateEnd': DateEnd,
        'OwningConsultantID': JsonConverters.toJson(OwningConsultantID,'List<String>',context!),
        'TransactionAgencyLocationID': JsonConverters.toJson(TransactionAgencyLocationID,'List<String>',context!),
        'RequestConsultantID': RequestConsultantID
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'ConsultantActiveUnsoldAirBooking': TypeInfo(TypeOf.Class, create:() => ConsultantActiveUnsoldAirBooking()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'GetConsultantWorkActiveUnsoldAirResponseReport': TypeInfo(TypeOf.Class, create:() => GetConsultantWorkActiveUnsoldAirResponseReport()),
    '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()),
    'GetConsultantWorkActiveUnsoldAirItemResponse': TypeInfo(TypeOf.Class, create:() => GetConsultantWorkActiveUnsoldAirItemResponse()),
    'GetConsultantWorkActiveUnsoldAir': TypeInfo(TypeOf.Class, create:() => GetConsultantWorkActiveUnsoldAir()),
});

Dart GetConsultantWorkActiveUnsoldAir 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.

POST /ConsultantWorkActiveUnsoldAir HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DateStart":"String","DateEnd":"String","OwningConsultantID":["String"],"TransactionAgencyLocationID":["String"],"RequestConsultantID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

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)\/","OwningAgencyLocationID":"String","GdsCode":"String","PrimaryPax":"String","OwningConsultant":"String","OwningConsultantID":"String","Account":"String","AgentivityRef":0,"PrimaryCarrierCode":"String","FiledFare":"String","TravelDate":"\/Date(-62135596800000-0000)\/","DestinationCities":"String","BookingClasses":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}