Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-rand-history

Retrieves unblinded randomization history for all subjects within the study. Rights: OrsSubjectVisitGet.

Request

Path Parameters

• 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

Query Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Unblinded Randomization History v1.0

Type: object

Title: Unblinded Randomization History v1.0

Contains unblinded randomization history.

Show Source

• treatmentArms: array treatmentArms

{
    "title":"Unblinded Randomization History v1.0",
    "type":"object",
    "properties":{
        "treatmentArms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandomizationDetailsDTO"
            }
        }
    },
    "description":"Contains unblinded randomization history."
}

Nested Schema : treatmentArms

Type: array

Show Source

• Array of: object Randomization Details
  Title: Randomization Details

  Contains randomization details.

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

Nested Schema : Randomization Details

Type: object

Title: Randomization Details

Contains randomization details.

Show Source

• description: string
  Randomization description.

  Example: RndA
• externalTreatmentId: string
  External treatment ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• id: string (uuid)
  Randomization ID.
• randNumber: number (double)
  Randomization number.

  Example: 5
• randomizationDate: string (date-time)
  Randomization date.
• rndStatusId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5 ]

  Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).

  Example: 1
• visitId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

{
    "title":"Randomization Details",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Randomization ID.",
            "format":"uuid"
        },
        "randNumber":{
            "type":"number",
            "description":"Randomization number.",
            "format":"double",
            "example":5
        },
        "randomizationDate":{
            "type":"string",
            "description":"Randomization date.",
            "format":"date-time"
        },
        "rndStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each Randomization status value (1 for Not Approved, 2 for Available, 3 for Not Released, 4 for Assigned, 5 for Randomized in Error).",
            "format":"double",
            "example":1,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        },
        "description":{
            "type":"string",
            "description":"Randomization description.",
            "example":"RndA"
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"External treatment ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        }
    },
    "description":"Contains randomization details.",
    "example":{
        "treatmentArmId":"E0E1E2E3E4E5E6E7E8E9EAEBECEDEEEF",
        "treatmentArmName":"Arm A"
    }
}

Example:

{
    "treatmentArmId":"E0E1E2E3E4E5E6E7E8E9EAEBECEDEEEF",
    "treatmentArmName":"Arm A"
}

Examples

Select an example Unblinded Randomization History For All Subjects Response

404 Response

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 Unblinded Randomization History For All Subjects 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 Unblinded Randomization History For All Subjects Server Error Response

Back to Top