POST api/Voice/UploadRecording

Upload a recording

Request Information

URI Parameters

None.

Body Parameters

RecordingUploadRequest
NameDescriptionTypeAdditional information
FileName

Name of the file inclusing extenstion

string

None.

FileData

Base64 conversion of the file contents

string

None.

ExternalID

ID of the account the file relates to

string

None.

ConsulationID

ID of the consultation from the external system for reference

string

None.

Consultant

Name of the doctor / consultant making the recording if not made by patient

string

None.

NotificationURL

A webhook URL which will be called when the file has completed processing

string

None.

RecordingTime

The time the recording was made

date

None.

Language

The language the recording was made in (use language codes, e.g. 'en' for English)

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FileName": "sample string 1",
  "FileData": "sample string 2",
  "ExternalID": "sample string 3",
  "ConsulationID": "sample string 4",
  "Consultant": "sample string 5",
  "NotificationURL": "sample string 6",
  "RecordingTime": "2022-11-09T13:53:49.7533865+00:00",
  "Language": "sample string 7"
}

application/xml, text/xml

Sample:
<RecordingUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models">
  <ConsulationID>sample string 4</ConsulationID>
  <Consultant>sample string 5</Consultant>
  <ExternalID>sample string 3</ExternalID>
  <FileData>sample string 2</FileData>
  <FileName>sample string 1</FileName>
  <Language>sample string 7</Language>
  <NotificationURL>sample string 6</NotificationURL>
  <RecordingTime>2022-11-09T13:53:49.7533865+00:00</RecordingTime>
</RecordingUploadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.