Agentivity API

<back to all web services

GetConsultantDetails

The following routes are available for this service:
All Verbs/ConsultantDetails
GetConsultantDetails Parameters:
NameParameterData TypeRequiredDescription
ConsultantIDquerystringYesConsultant ID (sign on)
BookingSourcequerystringYesBooking system (1G, 1A or 1S)
RequestConsultantIDquerystringNoRequest Consultant ID (sign on)
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
ConsultantDetails Parameters:
NameParameterData TypeRequiredDescription
ConsultantformConsultantMainDetailsNo
ConsultantGroupsformConsultantGroupsNo
BookingSourcesformList<BookingSource>No
ConsultantMainDetails Parameters:
NameParameterData TypeRequiredDescription
FirstnameformstringNo
LastnameformstringNo
StaffNumberformstringNo
EmailformstringNo
OnLeaveformboolNo
ConsultantGroups Parameters:
NameParameterData TypeRequiredDescription
LeaveCoverformList<ConsultantInGroupDetails>No
ConsultantInGroupDetails Parameters:
NameParameterData TypeRequiredDescription
ConsultantIDformstringNo
FirstnameformstringNo
LastnameformstringNo
BookingSource Parameters:
NameParameterData TypeRequiredDescription
ConsultantIDformstringNo
BookingSourceCodeformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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