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
  • attachment_id - Attachment Id of the document to be rated
Request Headers
  • Authorization - contains client/user API keys
Request Body
  • rating (Optional) - represents the value to rate the attachment which can range from 1(worst) to 5(best), or null if unrated
  • liked (Optional) - represents whether the attachment was liked or not, or null if no feedback was provided.
  • comments (Optional) - give us feedback with a text comment. Can be up to 1000 characters in length.
XML or JSON with the details about the attachment rating.
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 entity with more details.
Error Codes
  • 10010 InvalidDocumentType - You may only rate output file attachments.
  • 10020 InvalidOrderType - Only output files from Transcription and Caption orders may be rated.
  • 10030 SingleFeedbackTypeMandatory - Rating and liked are optional fields but submitting one of them is mandatory.
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>