GET Studies?idFilter={idFilter}&statusMask={statusMask}&clientCompanyKey={clientCompanyKey}

Returns information about the Studies.
The list of Studies returned may be optionally filtered by id, status, and client company.
When filtering by id the asterisk * character may optionally be used as a leading or trailing wildcard.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
idFilter

If omitted, the returned Studies are not filtered by id.
Otherwise filter the returned Studies by this case-insensitive value.
Leading and/or trailing asterisk characters (character code 42) may be used:

  • Leading and trailing asterisk : study id must contain the string between the asterisk characters.
  • Leading asterisk: study id must end with the string after the asterisk character.
  • Trailing asterisk: study id must start with the string before the asterisk character.
  • No leading or trailing asterisk: study id must match the specified value.

Any asterisk character which is not the first or last character of the value is considered to be part of the requested id.

string

None.

statusMask

If omitted, Studies with any status are returned.
If present, a string containing these characters, the presence of which specifies the status of the Studies desired:

  • a: Archived
  • p: Coding in progress
  • c: Completed
  • d: Deleted
  • h: On hold
  • r: Review in progress
  • s: Shipping
  • u: Under construction

For example, the value 'pc' (or 'cp') returns Studies with 'Coding in progress' or 'Completed' status.

string

None.

clientCompanyKey

If omitted or null, the Studies returned are not filtered by Company.
Otherwise, the Studies returned are those assigned to the Company with the specified key.

integer

None.

Body Parameters

None.

Response Information

Returns information about the Studies.
The list of Studies returned may be optionally filtered by id, status, and client company.
When filtering by id the asterisk * character may optionally be used as a leading or trailing wildcard.

GetStudiesResponse
NameDescriptionTypeAdditional information
studies

A list of Studies.

Collection of Study

Required

errors

If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages.

Collection of string

None.