Jump to

• Request
• Response

v5.0

get

/ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers

Versioned to return sequenceNumber along with the randomization number. Rights: OrsRandListGet and OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• rndlistid(required): string
  ID of the randomization list.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• blockedBy: string(uuid)
  ID of the entity which has blocked the randomization number.
• cohortId: string
  ID of the cohort.
• groupId: string
  ID of the group in a stratum.
• limit: string
  Maximum number of records to display per page.

  Default Value: 100
• offset: string
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Default Value: 0
• searchString(required): string
  Search string.
• status: number
  Status of the randomization number.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Random Number Response

Type: object

Title: Random Number Response

Contains random number response.

Show Source

• count: integer (int64)
  Total count of result
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• limit: integer (int64)
  Maximum number of records to display per page.
• links: array links
• offset: integer (int64)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Example: 400
• randNumbers: array randNumbers
• totalResults: integer (int64)
  Total number of entities in response

{
    "title":"Random Number Response",
    "type":"object",
    "properties":{
        "randNumbers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RandNumbersTO"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    },
    "description":"Contains random number response."
}

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

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

Nested Schema : randNumbers

Type: array

Show Source

• Array of: object RandNumbersTO v4.0
  Title: RandNumbersTO v4.0

  Contains random number details.

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

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

• href: string
  Realtive URL
• rel: string
  link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

Nested Schema : RandNumbersTO v4.0

Type: object

Title: RandNumbersTO v4.0

Contains random number details.

Show Source

• blockingParamId: string
  Title: Blocking Parameter ID

  Unique ID of blocking parameter.

  Example: B1B8327AFAA6412287106192AB5984EF
• blockingParamName: string
  Title: Blocking Parameter Name

  Blocking parameter name.

  Example: site
• blockingParamValue: string
  Title: Blocking Parameter Value

  Blocking parameter value.

  Example: Site1001
• blockNumber: number (double)
  Title: Block Number

  Block number.

  Example: 10
• cohortId: string (uuid)
  Cohort ID.
• cohortName: string
  Cohort name.

  Example: Demo Cohort 1001
• externalTreatmentId: string
  Title: External Treatment ID

  External treatment ID.

  Example: Treatment arm 1001
• minimization: object MinimizationTO v1.0
  Title: MinimizationTO v1.0

  Contains minimization details.
• randNumber: number (double)
  Title: Randomization Number

  Randomization number.

  Example: 10
• randNumberId: string (uuid)
  Title: Randomization Number ID

  Unique ID for randomization number.
• randStatusId: integer (int32)
  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: 3
• randStatusKey: string
  Title: Randomization Status Key

  Allowed Values: [ "Unapproved", "Available", "Inactive", "Assigned", "Randomized in error" ]

  Randomization status key.

  Example: Assigned, Available
• sequenceNumber: number
  Title: Sequence Number

  Sequence number within the randomization list.

  Example: 1001
• statumId: string (uuid)
  Title: Stratum ID

  Unique Id for stratum.
• stratumName: string
  Title: Stratum Name

  Stratum name.

  Example: Male, Female
• subjectId: string (uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
• subjectNumber: string
  Title: Subject Number

  Subject number.

  Example: S1001
• treatmentId: string (uuid)
  Title: Treatment ID

  Unique ID for treatment arm.
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"RandNumbersTO v4.0",
    "type":"object",
    "properties":{
        "randNumberId":{
            "title":"Randomization Number ID",
            "type":"string",
            "description":"Unique ID for randomization number.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "randNumber":{
            "title":"Randomization Number",
            "type":"number",
            "description":"Randomization number.",
            "format":"double",
            "example":10
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"number",
            "description":"Block number.",
            "format":"double",
            "example":10
        },
        "randStatusId":{
            "type":"integer",
            "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":"int32",
            "example":3,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        },
        "randStatusKey":{
            "title":"Randomization Status Key",
            "type":"string",
            "description":"Randomization status key.",
            "example":"Assigned, Available",
            "enum":[
                "Unapproved",
                "Available",
                "Inactive",
                "Assigned",
                "Randomized in error"
            ]
        },
        "treatmentId":{
            "title":"Treatment ID",
            "type":"string",
            "description":"Unique ID for treatment arm.",
            "format":"uuid"
        },
        "externalTreatmentId":{
            "title":"External Treatment ID",
            "type":"string",
            "description":"External treatment ID.",
            "example":"Treatment arm 1001 "
        },
        "blockingParamName":{
            "title":"Blocking Parameter Name",
            "type":"string",
            "description":"Blocking parameter name.",
            "example":"site"
        },
        "blockingParamId":{
            "title":"Blocking Parameter ID",
            "type":"string",
            "description":"Unique ID of blocking parameter.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "blockingParamValue":{
            "title":"Blocking Parameter Value",
            "type":"string",
            "description":"Blocking parameter value.",
            "example":"Site1001"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"uuid"
        },
        "subjectNumber":{
            "title":"Subject Number",
            "type":"string",
            "description":"Subject number.",
            "example":"S1001"
        },
        "statumId":{
            "title":"Stratum ID",
            "type":"string",
            "description":"Unique Id for stratum.",
            "format":"uuid"
        },
        "stratumName":{
            "title":"Stratum Name",
            "type":"string",
            "description":"Stratum name.",
            "example":"Male, Female"
        },
        "cohortId":{
            "type":"string",
            "description":"Cohort ID.",
            "format":"uuid"
        },
        "cohortName":{
            "type":"string",
            "description":"Cohort name.",
            "example":"Demo Cohort 1001"
        },
        "minimization":{
            "$ref":"#/components/schemas/MinimizationTO"
        },
        "sequenceNumber":{
            "title":"Sequence Number",
            "type":"number",
            "description":"Sequence number within the randomization list.",
            "example":1001
        }
    },
    "description":"Contains random number details."
}

Nested Schema : MinimizationTO v1.0

Type: object

Title: MinimizationTO v1.0

Contains minimization details.

Show Source

• groups: array groups
• probabilityFactor: string
  Title: Probability Factor

  Probability factor for a given random number.

  Example: 0.23

{
    "title":"MinimizationTO v1.0",
    "type":"object",
    "properties":{
        "probabilityFactor":{
            "title":"Probability Factor",
            "type":"string",
            "description":"Probability factor for a given random number.",
            "example":"0.23"
        },
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MinimizationGroupTO"
            }
        }
    },
    "description":"Contains minimization details."
}

Nested Schema : groups

Type: array

Show Source

• Array of: object MinimizationGroupTO v1.0
  Title: MinimizationGroupTO v1.0

  Contains minimization group details.

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

Nested Schema : MinimizationGroupTO v1.0

Type: object

Title: MinimizationGroupTO v1.0

Contains minimization group details.

Show Source

• groupId: string (UUID)
  Title: Group ID

  Unique ID for group.

  Example: B1B8327AFAA6412287106192AB5984EF
• groupName: string
  Title: Group Name

  Name of the group.

  Example: Smoker, Non-smoker
• stratumId: string (UUID)
  Title: Stratum ID

  Unique ID for stratum.

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"MinimizationGroupTO v1.0",
    "type":"object",
    "properties":{
        "stratumId":{
            "title":"Stratum ID",
            "type":"string",
            "description":"Unique ID for stratum.",
            "format":"UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "groupId":{
            "title":"Group ID",
            "type":"string",
            "description":"Unique ID for group.",
            "format":"UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "groupName":{
            "title":"Group Name",
            "type":"string",
            "description":"Name of the group.",
            "example":"Smoker, Non-smoker"
        }
    },
    "description":"Contains minimization group details."
}

404 Response

Appears for invalid study ID, invalid study version, or if a randomization list isn't 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

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

Back to Top