GET | /ConsultantsProductivity |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PNRCreationDateStart | query | string | Yes | Date in format YYYYMMDD |
PNRCreationDateEnd | query | string | Yes | Date in format YYYYMMDD |
OwningAgencyLocationID | query | string | No | Owning agency location IDs |
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 |
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) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseMetadata | form | ResponseMetadata | No | |
ResponseReport | form | TReport | No | |
ResponseError | form | AgentivityError | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
HasCache | form | bool | No | |
HasPaging | form | bool | No | |
CacheMetadata | form | CacheMetadata | No | |
PagingMetadata | form | PagingMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CachedAt | form | DateTime | No | |
CacheExpiresAt | form | DateTime | No | |
IsFromCache | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorCode | form | string | No | |
Message | form | string | No | |
StatusCode | form | string | No | |
VerboseMessage | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OwningConsultant | form | string | No | |
OwningConsultantID | form | string | No | |
OwningAgencyLocationID | form | string | No | |
Location | form | string | No | |
Team | form | string | No | |
TotalCreated | form | int | No | |
TotalCancelled | form | int | No | |
TotalItinChanges | form | int | No |
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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET //ConsultantsProductivity 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":{"Item":{"OwningConsultant":"String","OwningConsultantID":"String","OwningAgencyLocationID":"String","Location":"String","Team":"String","TotalCreated":0,"TotalCancelled":0,"TotalItinChanges":0}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}