Agentivity API

GetConsultantDetails

The following routes are available for this service:
All Verbs	/ConsultantDetails

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

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

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

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

    // @DataMember(Order=50)
    bool? OnLeave;

    ConsultantMainDetails({this.Firstname,this.Lastname,this.StaffNumber,this.Email,this.OnLeave});
    ConsultantMainDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Firstname = json['Firstname'];
        Lastname = json['Lastname'];
        StaffNumber = json['StaffNumber'];
        Email = json['Email'];
        OnLeave = json['OnLeave'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Firstname': Firstname,
        'Lastname': Lastname,
        'StaffNumber': StaffNumber,
        'Email': Email,
        'OnLeave': OnLeave
    };

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

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

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

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

    ConsultantInGroupDetails({this.ConsultantID,this.Firstname,this.Lastname});
    ConsultantInGroupDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ConsultantID = json['ConsultantID'];
        Firstname = json['Firstname'];
        Lastname = json['Lastname'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ConsultantID': ConsultantID,
        'Firstname': Firstname,
        'Lastname': Lastname
    };

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

// @DataContract(Name="ConsultantGroups", Namespace="schemas.agentivity.com/types")
class ConsultantGroups implements IConvertible
{
    // @DataMember(Order=10)
    List<ConsultantInGroupDetails>? LeaveCover;

    ConsultantGroups({this.LeaveCover});
    ConsultantGroups.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'LeaveCover': JsonConverters.toJson(LeaveCover,'List<ConsultantInGroupDetails>',context!)
    };

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

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

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

    BookingSource({this.ConsultantID,this.BookingSourceCode});
    BookingSource.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ConsultantID': ConsultantID,
        'BookingSourceCode': BookingSourceCode
    };

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

// @DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")
class ConsultantDetails implements IConvertible
{
    // @DataMember(Order=10)
    ConsultantMainDetails? Consultant;

    // @DataMember(Order=20)
    ConsultantGroups? ConsultantGroups;

    // @DataMember(Order=30)
    List<BookingSource>? BookingSources;

    ConsultantDetails({this.Consultant,this.ConsultantGroups,this.BookingSources});
    ConsultantDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Consultant = JsonConverters.fromJson(json['Consultant'],'ConsultantMainDetails',context!);
        ConsultantGroups = JsonConverters.fromJson(json['ConsultantGroups'],'ConsultantGroups',context!);
        BookingSources = JsonConverters.fromJson(json['BookingSources'],'List<BookingSource>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Consultant': JsonConverters.toJson(Consultant,'ConsultantMainDetails',context!),
        'ConsultantGroups': JsonConverters.toJson(ConsultantGroups,'ConsultantGroups',context!),
        'BookingSources': JsonConverters.toJson(BookingSources,'List<BookingSource>',context!)
    };

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

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetConsultantDetails extends CompanyLevelRequestBase implements IRequestConsultantID, IConvertible
{
    /**
    * Consultant ID (sign on)
    */
    // @DataMember
    String? ConsultantID;

    /**
    * Booking system (1G, 1A or 1S)
    */
    // @DataMember
    String? BookingSource;

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

    GetConsultantDetails({this.ConsultantID,this.BookingSource,this.RequestConsultantID});
    GetConsultantDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ConsultantID = json['ConsultantID'];
        BookingSource = json['BookingSource'];
        RequestConsultantID = json['RequestConsultantID'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ConsultantID': ConsultantID,
        'BookingSource': BookingSource,
        'RequestConsultantID': RequestConsultantID
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'ConsultantMainDetails': TypeInfo(TypeOf.Class, create:() => ConsultantMainDetails()),
    'ConsultantInGroupDetails': TypeInfo(TypeOf.Class, create:() => ConsultantInGroupDetails()),
    'ConsultantGroups': TypeInfo(TypeOf.Class, create:() => ConsultantGroups()),
    'List<ConsultantInGroupDetails>': TypeInfo(TypeOf.Class, create:() => <ConsultantInGroupDetails>[]),
    'BookingSource': TypeInfo(TypeOf.Class, create:() => BookingSource()),
    'ConsultantDetails': TypeInfo(TypeOf.Class, create:() => ConsultantDetails()),
    'List<BookingSource>': TypeInfo(TypeOf.Class, create:() => <BookingSource>[]),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'GetConsultantDetailsResponseReport': TypeInfo(TypeOf.Class, create:() => GetConsultantDetailsResponseReport()),
    '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()),
    'GetConsultantDetailsItemResponse': TypeInfo(TypeOf.Class, create:() => GetConsultantDetailsItemResponse()),
    'GetConsultantDetails': TypeInfo(TypeOf.Class, create:() => GetConsultantDetails()),
});

Dart GetConsultantDetails 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 /ConsultantDetails HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ConsultantID":"String","BookingSource":"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":{"Consultant":{"Firstname":"String","Lastname":"String","StaffNumber":"String","Email":"String","OnLeave":false},"ConsultantGroups":{"LeaveCover":[{"ConsultantID":"String","Firstname":"String","Lastname":"String"}]},"BookingSources":[{"ConsultantID":"String","BookingSourceCode":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}