Operations
POST /attachments/{attachment_id}/rate
Summary | Rate an attachment |
---|---|
URL | /api/v1/attachments/{attachment_id}/rate |
Detailed Description | Provide Rev with feedback on the quality of the document you received. |
Request Parameters |
|
Request Headers |
|
Request Body |
Rating and liked are optional fields but submitting one of them is mandatory. Submitting both or submitting none of them will result in an error and the request won't be processed. See below for an example entity illustrating the fields used. |
Response |
On success, 200 Success. On error, 400 Bad Request. |
Response Headers | None |
Response Body | On success, empty. On error, will contain an |
Error Codes |
|
Annotated sample request |
{ /* Rating from 1 - 5. */ "rating": 5, /* Comment of up to 1000 characters */ "comments": "This transcript is perfect!" } { /* Liked or not: true or false. */ "liked": true, /* Comment of up to 1000 characters */ "comments": "This transcript is perfect!" } <!-- Rating from 1 - 5. --> <rating>5</rating> <!-- Comment of up to 1000 characters --> <comments>"Really knocked it out of the park this time"</comments> <!-- Liked or not: true or false. --> <liked>true</liked> <!-- Comment of up to 1000 characters --> <comments>"Really knocked it out of the park this time"</comments> |