Jump to

• Request
• Response

V1

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/{studyVersion}/demographicstatus

Retrieves list of subjects that have specific demographic details available, like gender, race and date of birth.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  ABCDEF1234567890ABCDEF1234567890

• studyVersion(required): string
  String representing the version of the study. Helps track changes in form or study design.

  Example:

  3.1.0.0

• subjectId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DemographicStatusResponse
  Response indicating whether demographic data (gender, date of birth, race) is available for a subject.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DemographicStatusResponse"
    }
}

Nested Schema : DemographicStatusResponse

Type: object

Response indicating whether demographic data (gender, date of birth, race) is available for a subject.

Show Source

• dobDataAvailable: boolean
  True if date of birth data is available for this subject.

  Example: false
• genderDataAvailable: boolean
  True if gender data is available for this subject.

  Example: true
• raceDataAvailable: boolean
  True if race data is available for this subject.

  Example: true

{
    "type":"object",
    "properties":{
        "genderDataAvailable":{
            "type":"boolean",
            "description":"True if gender data is available for this subject.",
            "example":true
        },
        "dobDataAvailable":{
            "type":"boolean",
            "description":"True if date of birth data is available for this subject.",
            "example":false
        },
        "raceDataAvailable":{
            "type":"boolean",
            "description":"True if race data is available for this subject.",
            "example":true
        }
    },
    "description":"Response indicating whether demographic data (gender, date of birth, race) is available for a subject."
}

Examples

Select an example Example demographic status result

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top