GET /comments/{parentRowType}/{parentRowId}
Retrieves a list of comments for a given parent row type and row ID. For example,
driver BJM01 would be requested as "/D/BJM01", where 'D' represents the parent row type
of a driver and 'BJM01' the ID for the driver record.
Roles that can access this endpoint are Users, Drivers, Carriers, Carrier Drivers.
Parameters
name |
description |
type |
default |
type |
parentRowType |
the comment record's parent row type |
path
|
|
String
|
parentRowId |
the comment record's parent row ID |
path
|
|
String
|
Result
List
<
RowComments
>
of type:
application/xml
application/json
list of RowComments records
Additional attributes:
__commentTypeDescr
This value represents the description of the comment type, found in the comments.comment_type_id
field.
Child Elements:
RowUsers
This element represents the entered by user associated with the comments.entered_user_id
field. This element contains a __name
attribute with the value enteredByUser
.
Try It Out
Request