Agentivity API

GetConsultantDetails

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

**GetConsultantDetails** Parameters:
Name	Parameter	Data Type	Required	Description
ConsultantID	query	string	Yes	Consultant ID (sign on)
BookingSource	query	string	Yes	Booking system (1G, 1A or 1S)
RequestConsultantID	query	string	No	Request Consultant ID (sign on)

**CompanyLevelRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
OwningCompanyCode	query	string	No	Comma Delimited List of Owning Company Codes
UserName	query	string	No	UserName in form of an email address

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**ConsultantDetails** Parameters:
Name	Parameter	Data Type	Required
Consultant	form	ConsultantMainDetails	No
ConsultantGroups	form	ConsultantGroups	No
BookingSources	form	List<BookingSource>	No

**ConsultantMainDetails** Parameters:
Name	Parameter	Data Type	Required
Firstname	form	string	No
Lastname	form	string	No
StaffNumber	form	string	No
Email	form	string	No
OnLeave	form	bool	No

**ConsultantGroups** Parameters:
Name	Parameter	Data Type	Required	Description
LeaveCover	form	List<ConsultantInGroupDetails>	No

**ConsultantInGroupDetails** Parameters:
Name	Parameter	Data Type	Required
ConsultantID	form	string	No
Firstname	form	string	No
Lastname	form	string	No

**BookingSource** Parameters:
Name	Parameter	Data Type	Required	Description
ConsultantID	form	string	No
BookingSourceCode	form	string	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	No

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetConsultantDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <BookingSource>String</BookingSource>
  <ConsultantID>String</ConsultantID>
  <RequestConsultantID>String</RequestConsultantID>
</GetConsultantDetails>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <Consultant>
        <Firstname>String</Firstname>
        <Lastname>String</Lastname>
        <StaffNumber>String</StaffNumber>
        <Email>String</Email>
        <OnLeave>false</OnLeave>
      </Consultant>
      <ConsultantGroups>
        <LeaveCover>
          <Consultant>
            <ConsultantID>String</ConsultantID>
            <Firstname>String</Firstname>
            <Lastname>String</Lastname>
          </Consultant>
        </LeaveCover>
      </ConsultantGroups>
      <BookingSources>
        <BookingSource>
          <ConsultantID>String</ConsultantID>
          <BookingSourceCode>String</BookingSourceCode>
        </BookingSource>
      </BookingSources>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>