Agentivity API

<back to all web services

GetQcCommentsForConsultant

The following routes are available for this service:
GET/QcCommentsForConsultant
GetQcCommentsForConsultant Parameters:
NameParameterData TypeRequiredDescription
ConsultantquerystringYesConsultant full name
AgentInitialsquerystringNoAgent initials
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
TeamquerystringNoTeam name
DateByCommentsquerybooleanNoSort date by comments
GroupByAgentInitialsquerybooleanNoGroup by agent initials
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)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<TItem>No
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
QcCommentsForConsultant Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
ConsultantformstringNo
AgentInitialsformstringNo
CommentformstringNo
CommentDateformDateTimeNo

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.

GET //QcCommentsForConsultant HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
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":[{"RecordLocator":"String","Consultant":"String","AgentInitials":"String","Comment":"String","CommentDate":"\/Date(-62135596800000-0000)\/"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}