[GET] Workspace Speakers

Use this request to get information about speakers in a specific workspace.

Workspace Speakers

GET/api/v1.0/external/transcripts/speakers/workspaces/{workspaceId}

Path Parameters

Name	Type	Description
workspaceId	integer	The ID that identifies the workspace to retrieve data on. This ID is always unique and never changes after it has been created.

Example Request

curl

curl -X 'GET' \
  'https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/workspaces/1234' \
  --header 'Authorization: Bearer {your access token here}' \
  --header 'accept: application/json'

C#

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/workspaces/1234");
request.Headers.Add("Authorization", "Bearer {your access token here}");
request.Headers.Add("Accept", "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

Console.WriteLine(await response.Content.ReadAsStringAsync());

Python

import requests

url = "https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/workspaces/1234"

headers = {
    'Authorization': 'Bearer {your access token here}',
    'Accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.text)

Javascript

const myHeaders = new Headers();
myHeaders.append("Authorization", `Bearer {your access token here}`);
myHeaders.append("Accept", "application/json");

const requestOptions = {
    method: 'GET',
    headers: myHeaders
};

fetch("https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/workspaces/1234", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Responses

200 OK

{
  "speakers": [
    {
      "speakerId": "93492c69-c385-4876-be54-4e8c461ebebc",
      "speakerName": "Some Name",
      "speakerPrefix": "Some Prefix",
      "speakerSuffix": "Some Suffix"
    }
  ]
}

Response Body ExternalWorkspaceSpeakers

Name	Type	Description
speakers	[ExternalWorkspaceSpeakerViewModel]	The list of speakers.

Response Body ExternalWorkspaceSpeakerViewModel

Name	Type	Description
speakerId	string	The unique identifier of your Speaker.
speakerName	string	The name of your Speaker.
speakerPrefix	string (optional)	Optional prefix for your Speaker.
speakerSuffix	string (optional)	Optional suffix for your Speaker.

500 Internal Server Error

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
  "title": "InternalError",
  "status": 500,
  "detail": "An unexpected error occurred while retrieving speakers.",
  "instance": null,
  "extensions": {
    "traceId": "00-d5581449c3b8b2ee06b30ef0b8278997-0ed9bec6d644277e-01"
  }
}

Response Body Problem Detail JSON Object