List all recordings for a record

1 min

GET

https://developer.digitail.io/api/v1/records/{id}/quick-record-recordings

Permissions needed: ACCESS_PATIENTS

Returns the QuickSOAP recordings on the record, newest first, each with its transcription and transcription_status. It includes recordings whose draft was already applied to the record or deleted. Recordings that are still uploading are usually left out, so only use a transcription once its transcription_status is completed.

Use search to find recordings whose transcription contains a text (case-insensitive).

Query Parameters

searchstring
Description
Text to look for in the recording's transcription. Case-insensitive.
per_pageinteger
Description
Number of recordings per page.
Default
10
Minimum
1
Maximum
100

Responses

200Successful operation

object
- dataobject[]
  - idinteger
    Example
    1
  - quick_record_idinteger
    Example
    1
  - urlstring
    Example
    https://example.com/recording.mp3
  - transcriptionstring
    Example
    This is what the recording says.
  - transcription_statusstring<pending | processing | completed | failed>
    Description
    Current transcription status
    Allowed
    pendingprocessingcompletedfailed
  - transcription_languagestring
    Example
    en
    Description
    Language code used for transcription
  - last_chunk_numberinteger
    Example
    25
    Description
    Last uploaded chunk number. Present while chunks are being uploaded, removed after merge.
  - merge_statusstring<pending | processing | completed | failed>
    Description
    Current merge status of recording chunks
    Allowed
    pendingprocessingcompletedfailed
  - created_atstring
    Example
    2024-11-27T10:06:56.000000Z
  - updated_atstring
    Example
    2024-11-27T10:06:56.000000Z
- linkslinks
- metameta

curl

curl --request GET \
     --url 'https://developer.digitail.io/api/v1/records/{id}/quick-record-recordings?per_page=10' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/records/{id}/quick-record-recordings?per_page=10", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/records/{id}/quick-record-recordings?per_page=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/records/{id}/quick-record-recordings?per_page=10"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "data": [
    {
      "id": 1,
      "quick_record_id": 1,
      "url": "https://example.com/recording.mp3",
      "transcription": "This is what the recording says.",
      "transcription_status": "",
      "transcription_language": "en",
      "last_chunk_number": 25,
      "merge_status": "",
      "created_at": "2024-11-27T10:06:56.000000Z",
      "updated_at": "2024-11-27T10:06:56.000000Z"
    }
  ],
  "links": {},
  "meta": {}
}