GET /mcmessages
Retrieves a List of RowMcMessage objects matching the given parameters.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| messageType |
indicates whether to display (I)nbound, (O)utbound or (B)oth inbound and outbound messages (the default) |
query
|
B |
String
|
| currentOnly |
whether to include confirmed messages |
query
|
false |
Boolean
|
| users |
comma-delimited list of users for whom to return messages |
query
|
|
String
|
| drivers |
comma-delimited list of drivers for whom to return messages |
query
|
|
String
|
| units |
comma-delimited list of units for which to return messages |
query
|
|
String
|
| forms |
comma-delimited list of forms for which to return messages |
query
|
|
String
|
| daysToShow |
number of days back to show messages |
query
|
1 |
int
|
Result
List
<
RowMcMessage
>
of type:
application/xml
application/json
a list of RowMcMessage objects
Child Elements:
RowUsers This element represent the user associated with the message, by the mc_message.mc_user_id field.
The element contains a __name attribute with the value mcUser.
Try It Out
Request