Jump to

• Request
• Response

V1

get

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

Retrieves the organization ID (OrgId) used to generate subject number.

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

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  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 SubjectOrgIdDto v1
  Title: SubjectOrgIdDto v1

  OrgId used to generate subject number

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

Nested Schema : SubjectOrgIdDto v1

Type: object

Title: SubjectOrgIdDto v1

OrgId used to generate subject number

Show Source

• orgId: string
  Site/Organization unique identifier (UUID, 32-character uppercase hexadecimal string)

  Example: ABCDEF1234567890ABCDEF1234567890

{
    "title":"SubjectOrgIdDto v1",
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string",
            "description":"Site/Organization unique identifier (UUID, 32-character uppercase hexadecimal string)",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        }
    },
    "description":"OrgId used to generate subject number"
}

Examples

Select an example Example response for org ID lookup

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