Jump to

• Request
• Response

v2.0

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history

Retrieves randomization history. Rights: OrsSubjectVisitGet. Added new field: visit ID.

Request

Path Parameters

• externalSubjectId(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:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  test

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RandomizationHistoryResponse

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

Nested Schema : RandomizationHistoryResponse

Type: object

Show Source

• randNumber: integer (int64)
  Title: Randomization Number

  Randomization number.

  Example: 5
• randomizationDate: string (date-time)
  Title: Randomization Date

  Date of randomization.
• visitId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

{
    "type":"object",
    "properties":{
        "randNumber":{
            "title":"Randomization Number",
            "type":"integer",
            "description":"Randomization number.",
            "format":"int64",
            "example":5
        },
        "randomizationDate":{
            "title":"Randomization Date",
            "type":"string",
            "description":"Date of randomization.",
            "format":"date-time"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        }
    }
}

Examples

Select an example Randomization History Response

404 Response

For invalid study ID or version. Or subject not found.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Randomization History Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Randomization History Server Error Response

Back to Top