Agentivity API

<back to all web services

GetConsultantDetails

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class GetConsultantDetails : CompanyLevelRequestBase(), IRequestConsultantID
{
    /**
    * Consultant ID (sign on)
    */
    @DataMember
    open var ConsultantID:String? = null

    /**
    * Booking system (1G, 1A or 1S)
    */
    @DataMember
    open var BookingSource:String? = null

    /**
    * Request Consultant ID (sign on)
    */
    @DataMember
    override var RequestConsultantID:String? = null
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    @DataMember
    override var OwningCompanyCode:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    override var UserName:String? = null
}

@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
    /**
    * Starting Record
    */
    @DataMember
    @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    open var Offset:String? = null

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = null

    /**
    * 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")
    open var TotalRecords:Int? = null

    /**
    * 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")
    open var ResponseRecords:Int? = null
}

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

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

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var ResponseError:AgentivityError? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
    @DataMember(Order=0)
    open var Success:Boolean? = null

    @DataMember(Order=1)
    open var HasCache:Boolean? = null

    @DataMember(Order=2)
    open var HasPaging:Boolean? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var CacheMetadata:CacheMetadata? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    open var PagingMetadata:PagingMetadata? = null
}

@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
    @DataMember(Order=1)
    open var CachedAt:Date? = null

    @DataMember(Order=2)
    open var CacheExpiresAt:Date? = null

    @DataMember(Order=0)
    open var IsFromCache:Boolean? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
    @DataMember
    open var ErrorCode:String? = null

    @DataMember
    open var Message:String? = null

    @DataMember
    open var StatusCode:String? = null

    @DataMember
    open var VerboseMessage:String? = null
}

@DataContract(Name="ConsultantDetails", Namespace="schemas.agentivity.com/types")
open class ConsultantDetails
{
    @DataMember(Order=10)
    open var Consultant:ConsultantMainDetails? = null

    @DataMember(Order=20)
    open var ConsultantGroups:ConsultantGroups? = null

    @DataMember(Order=30)
    open var BookingSources:ArrayList<BookingSource>? = null
}

@DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
open class ConsultantMainDetails
{
    @DataMember(Order=10)
    open var Firstname:String? = null

    @DataMember(Order=20)
    open var Lastname:String? = null

    @DataMember(Order=30)
    open var StaffNumber:String? = null

    @DataMember(Order=40)
    open var Email:String? = null

    @DataMember(Order=50)
    open var OnLeave:Boolean? = null
}

@DataContract(Name="ConsultantGroups", Namespace="schemas.agentivity.com/types")
open class ConsultantGroups
{
    @DataMember(Order=10)
    open var LeaveCover:ArrayList<ConsultantInGroupDetails>? = null
}

@DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
open class ConsultantInGroupDetails
{
    @DataMember(Order=10)
    open var ConsultantID:String? = null

    @DataMember(Order=20)
    open var Firstname:String? = null

    @DataMember(Order=30)
    open var Lastname:String? = null
}

@DataContract(Name="BookingSource", Namespace="schemas.agentivity.com/types")
open class BookingSource
{
    @DataMember(Order=10)
    open var ConsultantID:String? = null

    @DataMember(Order=20)
    open var BookingSourceCode:String? = null
}

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

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin GetConsultantDetails DTOs

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"}}