Agentivity API

<back to all web services

ConsultantsGdsSegmentPerformance

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

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

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

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

    // @DataMember(Order=42)
    int? AirCountOnline;

    // @DataMember(Order=50)
    int? HotelCount;

    // @DataMember(Order=52)
    int? HotelCountOnline;

    // @DataMember(Order=60)
    int? CarCount;

    // @DataMember(Order=62)
    int? CarCountOnline;

    // @DataMember(Order=70)
    int? PassiveHotelCount;

    // @DataMember(Order=72)
    int? PassiveHotelCountOnline;

    // @DataMember(Order=80)
    int? PassiveCarCount;

    // @DataMember(Order=82)
    int? PassiveCarCountOnline;

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

    // @DataMember(Order=92)
    int? TURCountOnline;

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

    // @DataMember(Order=102)
    int? OtherCountOnline;

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

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

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

    ConsultantGdsSegmentPerformance({this.OwningConsultantID,this.OwningConsultant,this.OwningAgencyLocationID,this.AirCount,this.AirCountOnline,this.HotelCount,this.HotelCountOnline,this.CarCount,this.CarCountOnline,this.PassiveHotelCount,this.PassiveHotelCountOnline,this.PassiveCarCount,this.PassiveCarCountOnline,this.TURCount,this.TURCountOnline,this.OtherCount,this.OtherCountOnline,this.TotalBookings,this.OwningAgencyLocationCountryCode,this.OwningAgencyLocationCountryName});
    ConsultantGdsSegmentPerformance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        OwningConsultantID = json['OwningConsultantID'];
        OwningConsultant = json['OwningConsultant'];
        OwningAgencyLocationID = json['OwningAgencyLocationID'];
        AirCount = json['AirCount'];
        AirCountOnline = json['AirCountOnline'];
        HotelCount = json['HotelCount'];
        HotelCountOnline = json['HotelCountOnline'];
        CarCount = json['CarCount'];
        CarCountOnline = json['CarCountOnline'];
        PassiveHotelCount = json['PassiveHotelCount'];
        PassiveHotelCountOnline = json['PassiveHotelCountOnline'];
        PassiveCarCount = json['PassiveCarCount'];
        PassiveCarCountOnline = json['PassiveCarCountOnline'];
        TURCount = json['TURCount'];
        TURCountOnline = json['TURCountOnline'];
        OtherCount = json['OtherCount'];
        OtherCountOnline = json['OtherCountOnline'];
        TotalBookings = json['TotalBookings'];
        OwningAgencyLocationCountryCode = json['OwningAgencyLocationCountryCode'];
        OwningAgencyLocationCountryName = json['OwningAgencyLocationCountryName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'OwningConsultantID': OwningConsultantID,
        'OwningConsultant': OwningConsultant,
        'OwningAgencyLocationID': OwningAgencyLocationID,
        'AirCount': AirCount,
        'AirCountOnline': AirCountOnline,
        'HotelCount': HotelCount,
        'HotelCountOnline': HotelCountOnline,
        'CarCount': CarCount,
        'CarCountOnline': CarCountOnline,
        'PassiveHotelCount': PassiveHotelCount,
        'PassiveHotelCountOnline': PassiveHotelCountOnline,
        'PassiveCarCount': PassiveCarCount,
        'PassiveCarCountOnline': PassiveCarCountOnline,
        'TURCount': TURCount,
        'TURCountOnline': TURCountOnline,
        'OtherCount': OtherCount,
        'OtherCountOnline': OtherCountOnline,
        'TotalBookings': TotalBookings,
        'OwningAgencyLocationCountryCode': OwningAgencyLocationCountryCode,
        'OwningAgencyLocationCountryName': OwningAgencyLocationCountryName
    };

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

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

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

    /**
    * Comma Delimited List of PCCs
    */
    // @DataMember
    List<String>? OwningAgencyLocationID = [];

    ConsultantsGdsSegmentPerformance({this.PNRCreationDateStart,this.PNRCreationDateEnd,this.OwningAgencyLocationID});
    ConsultantsGdsSegmentPerformance.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart ConsultantsGdsSegmentPerformance DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /ConsultantsGdsSegmentPerformance 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":{"Item":{"OwningConsultantID":"String","OwningConsultant":"String","OwningAgencyLocationID":"String","AirCount":0,"AirCountOnline":0,"HotelCount":0,"HotelCountOnline":0,"CarCount":0,"CarCountOnline":0,"PassiveHotelCount":0,"PassiveHotelCountOnline":0,"PassiveCarCount":0,"PassiveCarCountOnline":0,"TURCount":0,"TURCountOnline":0,"OtherCount":0,"OtherCountOnline":0,"TotalBookings":0,"OwningAgencyLocationCountryCode":"String","OwningAgencyLocationCountryName":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}