Jump to

• Request
• Response

V1

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/idsforsitestudyversion

Lists all subjects for sites that you have access to and that have a study version.

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

Query Parameters

• siteId: string(uuid)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  BBAADD11223345566777889900CCDDEE

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 SubjectNumberDto
  Subject number mapping with state, ID, site, version and study linkage.

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

Nested Schema : SubjectNumberDto

Type: object

Subject number mapping with state, ID, site, version and study linkage.

Show Source

• id: string
  Subject unique identifier (UUID, 32-character uppercase hexadecimal string)

  Example: A1B2C3D4E5F60718273645AABBCCDDEE
• objectVersionNumber: integer (int32)
  Audit trail field that represents the version number of the data.

  Example: 3
• siteId: string
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• state(required): string
  Minimum Length: 0

  Maximum Length: 100

  Lifecycle state of the subject in the study. Reflects the subject???s current status. Common values include:

  • New
  • Active
  • Screening_Initiated
  • Screen_Failed
  • Withdrawn
  • Auto_Screen_Failed
  • Complete
  • Enrolled

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

  Example: ABCDEF1234567890ABCDEF1234567890
• studyVersion: string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  Unique subject Number representing the patient/participant enrolled in the study.

  Example: SUBJ-0002

{
    "required":[
        "state",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Subject unique identifier (UUID, 32-character uppercase hexadecimal string)",
            "example":"A1B2C3D4E5F60718273645AABBCCDDEE"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0002"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Lifecycle state of the subject in the study.  Reflects the subject???s current status. Common values include: <ul><li>New</li><li>Active</li><li>Screening_Initiated</li><li>Screen_Failed</li><li>Withdrawn</li><li>Auto_Screen_Failed</li><li>Complete</li><li>Enrolled</li></ul>",
            "example":"Active"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "objectVersionNumber":{
            "type":"integer",
            "description":"Audit trail field that represents the version number of the data.",
            "format":"int32",
            "example":3
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        }
    },
    "description":"Subject number mapping with state, ID, site, version and study linkage."
}

Examples

Select an example SubjectNumberDto Response

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top