| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Agent/{AgentId}/Communications |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Communications | form | List<AgentCommunication> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubAgentId | form | int | No | |
| SubAgentName | form | string | No | |
| AgentId | form | int | No | |
| AgentName | form | string | No | |
| DateCreated | form | DateTime | No | |
| Message | form | string | No | |
| MessageType | form | string | No | |
| IsAgentMessage | form | bool | No | |
| Sender | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Agent/{AgentId}/Communications HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Communications:
[
{
SubAgentId: 0,
SubAgentName: String,
AgentId: 0,
AgentName: String,
DateCreated: 0001-01-01,
Message: String,
MessageType: String,
IsAgentMessage: False,
Sender: String
}
]
}