Agentivity API

<back to all web services

DeparturesByClassName

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="Departure", Namespace="schemas.agentivity.com/types")
class Departure implements IConvertible
{
    // @DataMember(Order=10)
    String? RecordLocator;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Departure({this.RecordLocator,this.PNRCreationDate,this.AgentivityRef,this.Account,this.OwningConsultant,this.PNRTicketed,this.TravelDate,this.TicketedStatus,this.PaxList,this.Routing,this.AirSegCount,this.CarSegCount,this.HtlSegCount,this.CarPSegCount,this.HtlPSegCount,this.TrainSegCount,this.OtherSegCount});
    Departure.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RecordLocator = json['RecordLocator'];
        PNRCreationDate = json['PNRCreationDate'];
        AgentivityRef = json['AgentivityRef'];
        Account = json['Account'];
        OwningConsultant = json['OwningConsultant'];
        PNRTicketed = json['PNRTicketed'];
        TravelDate = json['TravelDate'];
        TicketedStatus = json['TicketedStatus'];
        PaxList = json['PaxList'];
        Routing = json['Routing'];
        AirSegCount = json['AirSegCount'];
        CarSegCount = json['CarSegCount'];
        HtlSegCount = json['HtlSegCount'];
        CarPSegCount = json['CarPSegCount'];
        HtlPSegCount = json['HtlPSegCount'];
        TrainSegCount = json['TrainSegCount'];
        OtherSegCount = json['OtherSegCount'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RecordLocator': RecordLocator,
        'PNRCreationDate': PNRCreationDate,
        'AgentivityRef': AgentivityRef,
        'Account': Account,
        'OwningConsultant': OwningConsultant,
        'PNRTicketed': PNRTicketed,
        'TravelDate': TravelDate,
        'TicketedStatus': TicketedStatus,
        'PaxList': PaxList,
        'Routing': Routing,
        'AirSegCount': AirSegCount,
        'CarSegCount': CarSegCount,
        'HtlSegCount': HtlSegCount,
        'CarPSegCount': CarPSegCount,
        'HtlPSegCount': HtlPSegCount,
        'TrainSegCount': TrainSegCount,
        'OtherSegCount': OtherSegCount
    };

    getTypeName() => "Departure";
    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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
class ApiRequestPerHour implements IConvertible
{
    // @DataMember(Order=10)
    DateTime? RequestDate;

    // @DataMember(Order=100)
    int? Hour0;

    // @DataMember(Order=110)
    int? Hour1;

    // @DataMember(Order=120)
    int? Hour2;

    // @DataMember(Order=130)
    int? Hour3;

    // @DataMember(Order=140)
    int? Hour4;

    // @DataMember(Order=150)
    int? Hour5;

    // @DataMember(Order=160)
    int? Hour6;

    // @DataMember(Order=170)
    int? Hour7;

    // @DataMember(Order=180)
    int? Hour8;

    // @DataMember(Order=190)
    int? Hour9;

    // @DataMember(Order=200)
    int? Hour10;

    // @DataMember(Order=210)
    int? Hour11;

    // @DataMember(Order=220)
    int? Hour12;

    // @DataMember(Order=230)
    int? Hour13;

    // @DataMember(Order=240)
    int? Hour14;

    // @DataMember(Order=250)
    int? Hour15;

    // @DataMember(Order=260)
    int? Hour16;

    // @DataMember(Order=270)
    int? Hour17;

    // @DataMember(Order=280)
    int? Hour18;

    // @DataMember(Order=290)
    int? Hour19;

    // @DataMember(Order=300)
    int? Hour20;

    // @DataMember(Order=310)
    int? Hour21;

    // @DataMember(Order=320)
    int? Hour22;

    // @DataMember(Order=330)
    int? Hour23;

    ApiRequestPerHour({this.RequestDate,this.Hour0,this.Hour1,this.Hour2,this.Hour3,this.Hour4,this.Hour5,this.Hour6,this.Hour7,this.Hour8,this.Hour9,this.Hour10,this.Hour11,this.Hour12,this.Hour13,this.Hour14,this.Hour15,this.Hour16,this.Hour17,this.Hour18,this.Hour19,this.Hour20,this.Hour21,this.Hour22,this.Hour23});
    ApiRequestPerHour.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RequestDate = JsonConverters.fromJson(json['RequestDate'],'DateTime',context!);
        Hour0 = json['Hour0'];
        Hour1 = json['Hour1'];
        Hour2 = json['Hour2'];
        Hour3 = json['Hour3'];
        Hour4 = json['Hour4'];
        Hour5 = json['Hour5'];
        Hour6 = json['Hour6'];
        Hour7 = json['Hour7'];
        Hour8 = json['Hour8'];
        Hour9 = json['Hour9'];
        Hour10 = json['Hour10'];
        Hour11 = json['Hour11'];
        Hour12 = json['Hour12'];
        Hour13 = json['Hour13'];
        Hour14 = json['Hour14'];
        Hour15 = json['Hour15'];
        Hour16 = json['Hour16'];
        Hour17 = json['Hour17'];
        Hour18 = json['Hour18'];
        Hour19 = json['Hour19'];
        Hour20 = json['Hour20'];
        Hour21 = json['Hour21'];
        Hour22 = json['Hour22'];
        Hour23 = json['Hour23'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RequestDate': JsonConverters.toJson(RequestDate,'DateTime',context!),
        'Hour0': Hour0,
        'Hour1': Hour1,
        'Hour2': Hour2,
        'Hour3': Hour3,
        'Hour4': Hour4,
        'Hour5': Hour5,
        'Hour6': Hour6,
        'Hour7': Hour7,
        'Hour8': Hour8,
        'Hour9': Hour9,
        'Hour10': Hour10,
        'Hour11': Hour11,
        'Hour12': Hour12,
        'Hour13': Hour13,
        'Hour14': Hour14,
        'Hour15': Hour15,
        'Hour16': Hour16,
        'Hour17': Hour17,
        'Hour18': Hour18,
        'Hour19': Hour19,
        'Hour20': Hour20,
        'Hour21': Hour21,
        'Hour22': Hour22,
        'Hour23': Hour23
    };

    getTypeName() => "ApiRequestPerHour";
    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 CollectionResponse<TItem> implements IConvertible
{
    // @DataMember(Order=1)
    ResponseMetadata? ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    List<ApiRequestPerHour>? ResponseReport;

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

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

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

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

    getTypeName() => "CollectionResponse<$TItem>";
    TypeContext? context = _ctx;
}

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

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

    /**
    * Name of the class
    */
    // @DataMember
    List<String>? ClassName;

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

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

    DeparturesByClassName({this.Account,this.ClassName,this.TravelDateStart,this.TravelDateEnd});
    DeparturesByClassName.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Account': JsonConverters.toJson(Account,'List<String>',context!),
        'ClassName': JsonConverters.toJson(ClassName,'List<String>',context!),
        'TravelDateStart': TravelDateStart,
        'TravelDateEnd': TravelDateEnd
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'Departure': TypeInfo(TypeOf.Class, create:() => Departure()),
    'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
    'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
    'ApiRequestPerHour': TypeInfo(TypeOf.Class, create:() => ApiRequestPerHour()),
    'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
    'CollectionResponse<TItem>': TypeInfo(TypeOf.Class, create:() => CollectionResponse<TItem>()),
    'List<ApiRequestPerHour>': TypeInfo(TypeOf.Class, create:() => <ApiRequestPerHour>[]),
    'DeparturesByClassNameResponse': TypeInfo(TypeOf.Class, create:() => DeparturesByClassNameResponse()),
    'DeparturesByClassName': TypeInfo(TypeOf.Class, create:() => DeparturesByClassName()),
});

Dart DeparturesByClassName DTOs

GET /DeparturesByClassName HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":[{"RecordLocator":"String","PNRCreationDate":"String","AgentivityRef":"String","Account":"String","OwningConsultant":"String","PNRTicketed":"String","TravelDate":"String","TicketedStatus":"String","PaxList":"String","Routing":"String","AirSegCount":"String","CarSegCount":"String","HtlSegCount":"String","CarPSegCount":"String","HtlPSegCount":"String","TrainSegCount":"String","OtherSegCount":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}