Agentivity API

GetQcCommentsForConsultant

The following routes are available for this service:
GET	/QcCommentsForConsultant

**GetQcCommentsForConsultant** Parameters:
Name	Parameter	Data Type	Required	Description
UserName	query	string	Yes	UserName in form of an email address
Consultant	query	string	Yes	Consultant full name
AgentInitials	query	string	No	Agent initials
DateStart	query	string	Yes	Date in format YYYYMMDD
DateEnd	query	string	Yes	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs
Team	query	string	No	Team name
DateByComments	query	boolean	No	Sort date by comments
GroupByAgentInitials	query	boolean	No	Group by agent initials

**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)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<TItem>	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

**QcCommentsForConsultant** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
Consultant	form	string	No
AgentInitials	form	string	No
Comment	form	string	No
CommentDate	form	DateTime	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.

GET //QcCommentsForConsultant HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

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>
    <QcCommentsForConsultant>
      <RecordLocator>String</RecordLocator>
      <Consultant>String</Consultant>
      <AgentInitials>String</AgentInitials>
      <Comment>String</Comment>
      <CommentDate>0001-01-01T00:00:00</CommentDate>
    </QcCommentsForConsultant>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>