NameDescriptionTypeAdditional information
quota

The quota for the Study

integer

None.
id

The id of the new Study.
Must be unique among all Studies in the Ascribe account of the current session by case-insensitive comparison.
Must be at least 1 character and not more than 30 characters.

string

Required

String length: inclusive between 1 and 30
name

Optional name of this Study, intended to be more human-friendly than the id of the Study.
Maximum of 50 characters.

string

String length: inclusive between 0 and 50
description

An optional description of the Study.

string

None.
status

Optional status of the Study at the time it is created.
If specified, one of:

  • u: Under construction
  • p: Coding in progress
  • h: On hold
If omitted the default status is 'Coding in progress'.

string

String length: inclusive between 0 and 1
supervisorKey

The key of the Person who will do revision of coding work
If no supervisor is set for the Study this field will not be present in the response.

integer

None.
clientCompanyKey

Optional key of the Company for which this coding work is being performed.

integer

None.
endCompanyKey

The key of the Company for which this coding work is being performed
If no end customer company is set for the Study this field will not be present in the response.

integer

None.
help

Optional text to assist workers coding this Study
This may be used to provide customer specific instructions to the coders for work on this Study.

string

None.
startDateUtc

UTC date/time the Study was started.

date

None.
dueDateUtc

UTC date/time the Study was completed.

date

None.