Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
328 lines (267 sloc) 8.67 KB

Enumeration Types

Enumeration types used in cielo24 API.

Error Type Enumeration

LOGIN_INVALID — Incorrect username or password was supplied as login credentials. Check that the the correct username and password are being sent.
ACCOUNT_EXISTS — Attempted to create an account that already exists. Login with the account, or create one with a different name.
ACCOUNT_UNPRIVILEGED — You are attempting to modify information of an account you do not have access to. You must be the owner, parent, or an administrator to modify an account’s information.
BAD_API_TOKEN — You have provided an incorrect API token. Either the session has gone valid, or the token provided was incorrect. Re-login to get a new session, or check that you submitted the correct token.
INVALID_QUERY — You passed a parameter or other information that could not be used for this command, see the ErrorComment for more specific information.
INVALID_OPTION — You supplied an option for a parameter that wasn't in it's approved option list. Please check the option list and try again.
MISSING_PARAMETER — You did not supply a required parameter for this function, see the ErrorComment for which parameter was missing.
INVALID_URL — You have provided a URL for a callback, media URL, or other URL that could not be accessed. Check the URL is correct, and try again.
ITEM_NOT_FOUND — You have provided an ID for a Job, task, billing item, contact info, or other item, that could not be found in the system. See the ErrorComment for more details on the item that was not found.

Job Status Enumeration

Authorizing
Pending
In Process
Complete
Media Failure
Reviewing

Priority Enumeration

STANDARD
PRIORITY

Fidelity Enumeration

MECHANICAL
PREMIUM — The Job Info Format returns this value as STANDARD
PROFESSIONAL — The Job Info Format returns this value as HIGH

JobDifficulty Enumeration

Indicates whether the job was difficult to process. This difficulty could be due to issues with media quality, cross-talk and background noise in the audio, strong accents of speakers, or complicated subject matter. The value of this field will update as the job is processed but will not change once the job has completed.

Good — The job was processed without any major problems.
Bad — A significant amount of the job was difficult to process. This may cause a delay of the expected due date.
Unknown — Not enough of the job has been analyzed at this time to determine whether it is difficult.

Caption Format Enumeration

DFXP
ECHO
QT
SAMI
SBV
SCC
SRT
TPM
TRANSCRIPT
TWX
WEB_VTT

Token Type Enumeration

word — Used to denote a word in the transcript.
punctuation — Used to denote punctuation in the transcript.
sound — Used to denote a sound or other non-word item in a transcript. If specified, a tag must also be specified on the token.

Sound Tag Enumeration

UNKNOWN
INAUDIBLE
CROSSTALK
MUSIC
NOISE
LAUGH
COUGH
FOREIGN
BLANK_AUDIO
APPLAUSE
BLEEP
ENDS_SENTENCE — Used to denote that this token ends the current sentence.

Speaker ID Enumeration

no
number
name

Speaker Gender Enumeration

UNKNOWN
MALE
FEMALE

Line Ending Enumeration

UNIX
WINDOWS
OSX

Case Enumeration

upper
lower
"" — (Empty string) represents unchanged case.

Customer Approval Steps Enumeration

TRANSLATION
RETURN

Customer Approval Tools Enumeration

AMARA
CIELO24

IWP Enumeration

PREMIUM
INTERIM_PROFESSIONAL
PROFESSIONAL
SPEAKER_ID
FINAL
MECHANICAL
CUSTOMER_APPROVED_RETURN
CUSTOMER_APPROVED_TRANSLATION