Jump to

• Request
• Response

V1

get

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

Retrieves available subject numbers and last added subject number according to the subject settings.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  ABCDEF1234567890ABCDEF1234567890

Query Parameters

• siteId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example:

  CDEF1234567890AB4567890EFEEDCBA12

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 SubjectNumberSelectionDTO
  DTO for subject number selection, containing the last assigned number and a list of currently available subject numbers.

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

Nested Schema : SubjectNumberSelectionDTO

Type: object

DTO for subject number selection, containing the last assigned number and a list of currently available subject numbers.

Show Source

• availableNumbers: array availableNumbers
  Available subject numbers
• lastAssignedNumber: string
  Last assigned subject number

  Example: SUBJ-1223

{
    "type":"object",
    "properties":{
        "lastAssignedNumber":{
            "type":"string",
            "description":"Last assigned subject number",
            "example":"SUBJ-1223"
        },
        "availableNumbers":{
            "type":"array",
            "description":"Available subject numbers",
            "example":"SUBJ-1224",
            "items":{
                "type":"string",
                "description":"Available subject numbers",
                "example":"SUBJ-1224"
            }
        }
    },
    "description":"DTO for subject number selection, containing the last assigned number and a list of currently available subject numbers."
}

Nested Schema : availableNumbers

Type: array

Available subject numbers

Show Source

• Array of: string
  Available subject numbers

  Example: SUBJ-1224

{
    "type":"array",
    "description":"Available subject numbers",
    "example":"SUBJ-1224",
    "items":{
        "type":"string",
        "description":"Available subject numbers",
        "example":"SUBJ-1224"
    }
}

Example:

SUBJ-1224

Examples

Select an example Example list of available subject numbers

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top