Operations
GET /orders (Legal Transcription)
| Summary | Get paged list of orders for user, including legal information |
|---|---|
| URL |
/api/v1/orders?page={pagenum}&pageSize={pageSize}&ids={orderNumber1}&ids={orderNumber2}..&ids={orderNumberN} /api/v1/orders?page={pagenum}&pageSize={pageSize}&clientRef={referenceId} |
| Request Query Parameters |
|
| Detailed Description |
Use this method to retrieve the list of orders for a user. The data will be returned as JSON or XML, depending on Accept header and/or URL extension. The list is returned in a paged manner. The returned result will indicate the total number of orders, as well as number of orders per page and the number of orders in the requested page, which enables a client to iteratively retrieve all orders for the user if desired. The results are ordered in reverse chronological order by the date the order was placed. Each order entity in the list contains summary information for the order - it omits comments and attachments. To get those, perform a GET /orders/{ordernum} with the appropriate order number.
Additionally, legal orders will contain a
See below for an annotated example of a response orders entity. |
| Request Headers |
|
| Response | On success, 200 OK |
| Response Headers | None |
| Response Body | An <orders/> entity with a list of orders for the user. This includes information about how many total orders there are, to enable fully paging through the result set. |
| 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 response |
/*
total_count is the total number of orders
results_per_page shows how may results are returned in each page
page is the number of the page returned (0-based)
*/
{
"total_count": 28,
"results_per_page": 8,
"page": 0,
"orders": [
{
/* Rev assigned order number */
"order_number": "TC432432",
/*
Client reference order number
provided with the order request
*/
"client_ref": "6",
/* Total cost of the order */
"price": 56,
/* When the order was placed, in UTC */
"placed_on": "2003-04-05T12:20:30.123Z",
/* Status of the order */
"status": "Transcribing",
/*
Total length of the audio (in seconds) of 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 and comments are not shown
in orders that are returned in this list.
Do a GET on orders/{ordernum} to get order attachments.
*/
}
/* the rest of the orders in the list */
]
}
<!--
total_count is the total number of orders
results_per_page shows how may results are returned in each page
page is the number of the page returned (0-based)
-->
<orders total_count="28" results_per_page="8" page="0">
<order>
<!-- Rev assigned order number -->
<order_number>TC432432</order_number>
<!-- Client reference order number provided with the order request -->
<client_ref>6</client_ref>
<!-- Total cost of the order -->
<price>56</price>
<!-- When the order was placed, in UTC -->
<placed_on>2003-04-05T12:20:30.123Z</placed_on>
<!-- Status of the order -->
<status>Transcribing</status>
<!--
total length of the audio (in seconds)
in media attachments for the order and additional services
-->
<transcription>
<total_length_seconds>300</total_length_seconds>
<verbatim>true</verbatim>
<timestamps>false</timestamps>
</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 and comments are not shown in orders that are returned
in the list. You can GET orders/{ordernum} to get order attachments.
-->
</order>
<!-- the rest of the matches -->
</orders>
|