Agentivity API

<back to all web services

GetConsultantDetails

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

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description 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")
    public TotalRecords: number;

    /** @description 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")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
export class ConsultantMainDetails
{
    // @DataMember(Order=10)
    public Firstname: string;

    // @DataMember(Order=20)
    public Lastname: string;

    // @DataMember(Order=30)
    public StaffNumber: string;

    // @DataMember(Order=40)
    public Email: string;

    // @DataMember(Order=50)
    public OnLeave: boolean;

    public constructor(init?: Partial<ConsultantMainDetails>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
export class ConsultantInGroupDetails
{
    // @DataMember(Order=10)
    public ConsultantID: string;

    // @DataMember(Order=20)
    public Firstname: string;

    // @DataMember(Order=30)
    public Lastname: string;

    public constructor(init?: Partial<ConsultantInGroupDetails>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ConsultantGroups", Namespace="schemas.agentivity.com/types")
export class ConsultantGroups
{
    // @DataMember(Order=10)
    public LeaveCover: ConsultantInGroupDetails[];

    public constructor(init?: Partial<ConsultantGroups>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="BookingSource", Namespace="schemas.agentivity.com/types")
export class BookingSource
{
    // @DataMember(Order=10)
    public ConsultantID: string;

    // @DataMember(Order=20)
    public BookingSourceCode: string;

    public constructor(init?: Partial<BookingSource>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=20)
    public ConsultantGroups: ConsultantGroups;

    // @DataMember(Order=30)
    public BookingSources: BookingSource[];

    public constructor(init?: Partial<ConsultantDetails>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")
export class GetConsultantDetailsResponseReport extends Report<GetConsultantDetailsItemResponse, ConsultantDetails>
{

    public constructor(init?: Partial<GetConsultantDetailsResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

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

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class GetConsultantDetailsItemResponse extends ItemResponse<ConsultantDetails, GetConsultantDetailsResponseReport>
{

    public constructor(init?: Partial<GetConsultantDetailsItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetConsultantDetails extends CompanyLevelRequestBase implements IRequestConsultantID
{
    /** @description Consultant ID (sign on) */
    // @DataMember
    public ConsultantID: string;

    /** @description Booking system (1G, 1A or 1S) */
    // @DataMember
    public BookingSource: string;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    public constructor(init?: Partial<GetConsultantDetails>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetConsultantDetails 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.

POST /ConsultantDetails HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
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: 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":{"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"}}