Operations

GET /orders/{ordernum} (Legal Transcription)

Summary Get detailed legal information about a specific order
URL /api/v1/orders/{ordernum}
Request Parameters
  • ordernum - the order number of the order to retrieve
Detailed Description

Use this method to retrieve legal-specific information about an order. The data will be returned as JSON or XML, depending on Accept header or URL extension. See below for an annotated example of a response order entity.

Order Status Description
Complete The order is complete. All attachments are available for download. Notifications will be sent. This is a terminal state.*
*Unless manually re-opened for quality control purposes
Cancelled The order was cancelled. This is a terminal state.

Other order status values are possible. However, only Complete and Cancelled are guaranteed not to change in v1 of the API.

Request Headers
  • Authorization - contains client/user API keys
  • Accept - indicates the format in which the response should be delivered. Must be application/json, application/xml, or text/xml
Response On success, 200 OK.
If the order with given order number is not found, 404 Not Found.
Response Headers None
Response Body

On success, an <order/> entity with the details about the order. On error, empty.

Additionally, legal orders will contain a legal_transcription section that includes specific information unique to legal orders. Within this section, the following will be included:

  • proceeding_type

    Denotes the type of proceeding that was ordered. The current list of supported legal proceeding types are as follows:

    • deposition
    • hearing
    • statement_on_record
    • examination_under_oath
    • trial
    • other

  • template

    Denotes the ID of the Ready To Certify template to be used when generating the transcript. This may be null if the order does not require a template to be used. Template IDs are accessible via a GET request to /templates.


  • deliverable_details

    Denotes a list of all legal deliverables attached to the order. Each delivery detail will contain the following information:

    • deliverable_type

      Denotes the type of legal deliverable that was placed on the order.

    • delivery_date

      Denotes the expected date and time (in UTC) the following completed deliverable will be returned back to you by.

    • delivered_on

      Denotes the date and time (in UTC) the following deliverable was delivered at. This value can be null if the deliverable has not been completed yet.

    Note: while all date times are specified as UTC, business days operate in Eastern time.
Error Codes None
Deliverable Type The following are a list of possible legal-specific deliverable type values based on what was ordered:
  • legal_ready_to_certify - Legal Ready to Certify transcripts for legal transcription orders
  • legal_human_rough_draft - Legal Human Rough Draft transcripts for legal transcription orders
  • legal_ai_rough_draft - Legal AI Rough Draft transcripts for legal transcription orders
    • Annotated sample legal transcription order response 
    {
    /* Rev assigned order number */
    "order_number": "TC432432",
    /* Client reference order number provided with the order request */
    "client_ref": "6",
    /* PO, Project, or Department provided with the order request */
    "po_number": "sampleponumber",
    /* Total cost of the order */
    "price": 56,
    /* When the order was placed, in UTC */
    "placed_on": "2024-06-18T12:20:30.123Z",
    /* When the entire order was delivered, in UTC */
    "delivered_on": "2024-06-20T01:57:50.06Z",
    /* Status of the order */
    "status": "Complete",
    /* 
        Total length of the audio in media attachments 
        for the order and additional services.
    */
    "transcription": {
        "total_length_seconds": 300,
        "verbatim": true,
        "timestamps": false
    },
    /*
        Specific information unique to legal orders.
    */
    "legal_transcription": {
        /* 
            The proceeding type of the legal order.
        */
        "proceeding_type": "deposition",
        /* 
            The ID of the Ready To Certify template to be used when generating the transcript. 
        */
        "template": 12345678,
        /* 
            A list of all legal deliverables attached to the order. 
        */
        "deliverable_details": [
            {
                /* 
                    The type of legal deliverable that was placed on the order. 
                */
                "deliverable_type": "legal_human_rough_draft",
                /* 
                    The expected date and time (in UTC) the following completed deliverable will be returned back to you by. 
                */
                "delivery_date": "2024-06-19T03:59:59Z",
                /*
                    The date and time (in UTC) the following deliverable was delivered at.
                */
                "delivered_on": "2024-06-19T02:57:28.89Z"
            },
            {
                "deliverable_type": "legal_ready_to_certify",
                "delivery_date": "2024-06-20T03:59:59Z",
                "delivered_on": "2024-06-20T01:57:50.06Z"
            },
            {
                "deliverable_type": "legal_ai_rough_draft",
                "delivery_date": "2024-06-18T17:38:23.4Z",
                "delivered_on": "2024-06-18T17:36:03.613Z"
            }
        ]
    },
    "attachments": [
        {
            /* attachment kind */
            "kind": "media",
            /* name for the attachment */
            "name": "VoiceRecording.mp3",
            /* id for the attachment */
            "id": "1C4AA80F4000000001000000F2EED32A3DD4775B1B0",
            "links": [
                {
                    /* 
                        link with URL of the resource 
                        for getting attachment content
                    */
                    "rel": "content",
                    "href": "https://api.rev.com/api/v1/attachments/1C4AA"
                }
            ]
        },
        {
            /* attachment kind */
            "kind": "transcript",
            /* name for the attachment */
            "name": "Transcript_draft.docx",
            /* id for the attachment */
            "id": "1C4AA80F4000000001000000F2EED32A3DD4775B1B0",
            /* deliverable type of the attachment */
            "deliverable_type": "legal_ai_rough_draft",
            "audio_length_seconds": 48,
            "links": [
                {
                  /* 
                    link with URL of the resource 
                    for getting attachment content 
                  */
                  "rel": "content",
                  "href": "https://api.rev.com/api/v1/attachments/1B4AA"
                }
            ]
        },
        {
            "kind": "transcript",
            "name": "Transcript_rough.docx",
            "id": "1C4AA80F4000000001000000F2EED32A3DD4775B1B1",
            "deliverable_type": "legal_human_rough_draft",
            "audio_length_seconds": 48,
            "links": [
                {
                  "rel": "content",
                  "href": "https://api.rev.com/api/v1/attachments/1B4AB"
                }
            ]
        },
        {
            "kind": "transcript",
            "name": "Transcript.docx",
            "id": "1C4AA80F4000000001000000F2EED32A3DD4775B1B2",
            "deliverable_type": "legal_ready_to_certify",
            "audio_length_seconds": 48,
            "links": [
                {
                  "rel": "content",
                  "href": "https://api.rev.com/api/v1/attachments/1B4AC"
                }
            ]
        }
    ],
    /* list of comments related to the order */
    "comments": [
        {
            /* who the comment is by */
            "by": "John S.",
            /* when the comment was made, in UTC */
            "timestamp": "2024-06-18T12:20:30.123Z",
            "text": "Please do it quickly"
        }
    ]
}
                
    <order>
    <!-- Rev assigned order number -->
    <order_number>TC432432</order_number>
    <!-- Client reference order number provided with the order request -->
    <client_ref>6</client_ref>
    <!-- PO, Project, or Department provided with the order request -->
    <po_number>sampleponumber</po_number>
    <!-- Total cost of the order -->
    <price>56</price>
    <!-- When the order was placed, in UTC -->
    <placed_on>2024-06-18T12:20:30.123</placed_on>
    <!-- When the entire order was delivered, in UTC -->
    <delivered_on>2024-06-20T01:57:50.06</delivered_on>
    <!-- Status of the order -->
    <status>Complete</status>
    <!-- 
        total length of the audio in media attachments 
        for the order and additional services 
    -->
    <transcription>
        <total_length_seconds>300</total_length_seconds>
        <verbatim>true</verbatim>
        <timestamps>false</timestamps>
    <!-- 
        total length of the audio in media attachments 
        for the order and additional services 
    -->
    </transcription>
    <!-- 
        Specific information unique to legal orders.
    -->
    <legal_transcription>
        <!-- 
            The proceeding type of the legal order.
        -->
        <proceeding_type>Deposition</proceeding_type>
        <!-- 
            The ID of the Ready To Certify template to be used when generating the transcript. 
        -->
        <template>241921285</template>
        <!-- 
            A list of all legal deliverables attached to the order.
        -->
        <deliverable_details>
            <!-- 
                The type of legal deliverable that was placed on the order. 
            -->
            <deliverable_type>legal_human_rough_draft</deliverable_type>
            <!-- 
                The expected date and time (in UTC) the following completed deliverable will be returned back to you by. 
            -->
            <delivery_date>2024-06-19T03:59:59</delivery_date>
            <!-- 
                The date and time (in UTC) the following deliverable was delivered at.
            -->
            <delivered_on>2024-06-19T02:57:28.89</delivered_on>
        </deliverable_details>
        <deliverable_details>
            <deliverable_type>legal_ready_to_certify</deliverable_type>
            <delivery_date>2024-06-20T03:59:59</delivery_date>
            <delivered_on>2024-06-20T01:57:50.06</delivered_on>
        </deliverable_details>
        <deliverable_details>
            <deliverable_type>legal_ai_rough_draft</deliverable_type>
            <delivery_date>2024-06-18T17:38:23.4</delivery_date>
            <delivered_on>2024-06-18T17:36:03.613</delivered_on>
        </deliverable_details>
    </legal_transcription>
    <attachments>
        <attachment>
            <!-- attachment kind -->
            <kind>media</kind>
            <!-- name for the attachment -->
            <name>VoiceRecording.mp3</name>
            <!-- id for the attachment -->
            <id>1C4AA80F4000000001000000F2EED32A3DD4775B1B0</id>
            <!-- link with URL of the resource for getting attachment content -->
            <link
               rel="content"
               href="https://api.rev.com/api/v1/attachments/1C4A/content"/>
        </attachment>
        <attachment>
            <kind>transcript</kind>
            <name>Transcript_draft.docx</name>
            <id>1C4AA80F4000000001000000F2EED32A3DD4775B1B0</id>
            <deliverable_type>legal_ai_rough_draft</deliverable_type>
            <link
               rel="content"
               href="https://api.rev.com/api/v1/attachments/234A/content"/>
        </attachment>
        <attachment>
            <kind>transcript</kind>
            <name>Transcript_rough.docx</name>
            <id>1C4AA80F4000000001000000F2EED32A3DD4775B1B1</id>
            <deliverable_type>legal_human_rough_draft</deliverable_type>
            <link
               rel="content"
               href="https://api.rev.com/api/v1/attachments/234B/content"/>
        </attachment>
        <attachment>
            <kind>transcript</kind>
            <name>Transcript.docx</name>
            <id>1C4AA80F4000000001000000F2EED32A3DD4775B1B2</id>
            <deliverable_type>legal_ready_to_certify</deliverable_type>
            <link
               rel="content"
               href="https://api.rev.com/api/v1/attachments/234C/content"/>
        </attachment>
    </attachments>
    <!-- list of comments related to the order -->
    <comments>
        <comment>
            <!-- who the comment is by -->
            <by>John S.</by>
            <!-- when the comment was made, in UTC -->
            <timestamp>2003-04-05 12:20:30</timestamp>
            <text>Please do it quickly</text>
        </comment>
    </comments>
</order>