Dictation

Name
Type
Description
id
uuid

The unique identifier of the dictation.

assignedTo

Specifies the team assignment.

state
int32

The state of the dictation. Possible values:
0 = Recording in progress,
1 = Recording suspended,
2 = Transcription pending,
3 = Transcription in progress,
4 = Transcription suspended,
5 = Transcription finished,
6 = Correction pending,
7 = Correction in progress,
8 = Correction suspended,
9 = Waiting for adaptation,
10 = Adaptation in progress,
11 = Queued for transcription service,
12 = Transcription service in progress,
13 = Queued for speech recognition,
14 = Speech recognition in progress

author
User
The author of the dictation.
lastModifiedByUser
User
The user who last modified the dictation.
priority
int32

A number between 0 and 15 that represents the priority of the dictation. [0 - 7] will be considered low priority, [8 - 14] will be considered high priority, and [15] will be considered critical priority.

hasTranscription
boolean

Indicates whether the dictation has a transcription.

soundLengthInMsec
int32

The dictation length in milliseconds.

lastChangeDateTimeUtc
date-time

The date and time (in UTC) when the dictation was last modified.

uploadDateTimeUtc
date-time

The date and time (in UTC) when the dictation was uploaded.

createDateTime
date-time

The date and time (in UTC) when the dictation was created.

tsLastDictationErrorCode
int32

The code of the last error that occurred in the transcription service.

tsLastDictationErrorText
string

The message of the last error that occurred in the transcription service.

title
string

The title of the dictation.

worktype
string

The work type of the dictation.

category
string

The category of the dictation.

comment
string

The comment that the user can add to the dictation.

department
string

The department associated with the dictation.

keyword
string

The keyword to help searching the dictation.

dpmBarcode
string

The barcode that identifies the dictation.

custom1
string

Custom property 1. These are properties that can be used for individual information assigned to a dictation e.g. Customer ID, Customer name, etc.

custom2
string

Custom property 2. These are properties that can be used for individual information assigned to a dictation e.g. Customer ID, Customer name, etc.

custom3
string

Custom property 3. These are properties that can be used for individual information assigned to a dictation e.g. Customer ID, Customer name, etc.

custom4
string

Custom property 4. These are properties that can be used for individual information assigned to a dictation e.g. Customer ID, Customer name, etc.

custom5
string

Custom property 5. These are properties that can be used for individual information assigned to a dictation e.g. Customer ID, Customer name, etc.

dueDateUtc
date-time

The due date for this dictation as set by the author.

audioInformation
AudioInformation
Audio information.
subscriptionId
int32

The identifier of the SpeechLive subscription.


AvailableAssignment

Name
Type
Description
id
uuid

The unique identifier of the team.

name
string

The name of the team.

assignmentType
int32

The assignment type. Possible values:
0 = DefaultTeam,
1 = PrivateTeam,
3 = SingleTeam,
4 = Team


User

Name
Type
Description
id
uuid

The unique identifier of the user.

role
int32

The user role. Possible values:
1 = Author,
2 = Transcriptionist,
3 = Undefined

state
int32

The user state. Possible values:
0 = Not invited,
1 = Invited,
2 = Activated but not used yet,
3 = Activated and in use

friendlyName
string

The display name of the user.


AudioInformation

Name
Type
Description
type
int32

The audio type. Possible values:
0 = Unknown,
1 = Wav,
2 = Ds2,
3 = Dss,
4 = M4a,
5 = Wma,
6 = Dra,
7 = Mp3

format
int32

The format of the audio type.

numOfChannels
int32

The number of channels in the audio.

sampleRate
int32

The sample rate of the audio.

byteRate
int32

The bytes sample of the audio.

blockAlign
int32

The audio block alignment. It represents the minimum atomic unit of data, in bytes, for the format type.

bitsPerSample
int32

The number of bits per sample in the audio.


Attachment

Name
Type
Description
id
uuid

The unique identifier of the attachment.

name
string

The name of the attachment.

sizeBytes
int64

the size (in bytes) of the attachment file.

fileHash
string

The hash of the attachment file.

hierarchy
string

Hierarchy path used for archived dictations in the SpeechExec software.

mimeType
string

The media type of the attachment. For example: 'audio/wav'(audio file), 'image/png' (image file), etc.

category
string

The category of the attachment. Possible values:
0 = Undefined,
1 = Metadata,
2 = Audio,
3 = Transcription
4 = Attachment.

dictationId
uuid

The unique identifier of the dictation to which the attachment is assigned.

subscriptionId
int32

The identifier of the subscription.

attachmentTypeVersion
int32

The type of the attachment. Possible values:
0 = Undefined,
1 = DictationFile,
2 = Attachment

createdAt
date-time

The date and time (in UTC) when the attachment was created. This property will be null for dictation files (audio, transcripion and metadata).

createdBy
uuid

The identifier of the user who created the attachment. This property will be null for dictation files (audio, transcripion and metadata).

modifiedBy
uuid

The identifier of the user who last modified the attachment. This property will be null for dictation files (audio, transcripion and metadata).


DictationDeleted

Name
Type
Description
id
uuid

The unique identifier of the dictation.

deletedByUser
User
The user who deleted the dictation.
deletedAt
date-time

The date and time (in UTC) when the dictation was deleted.

subscriptionId
int32

The identifier of the SpeechLive subscription.