Jump to

• Request
• Response

v3.0

get

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlistdesigns

Retrieves a randomization design list. Rights: OrsRandListGet, OrsUnblinded. Added new field: useSequenceNumber.

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:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

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 RndListDesignList
  Title: RndListDesignList

  Contains randomization list with associated randomization designs.

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

Nested Schema : RndListDesignList

Type: object

Title: RndListDesignList

Contains randomization list with associated randomization designs.

Show Source

• randDesigns: array randDesigns
• randListId: string (uuid)
  Unique ID for randomization list.
• randListName: string
  Randomization list name

  Example: UPL_RL191_V1001
• randomizationSeed: number (double)
  Title: Randomization Seed

  Seed number.

  Example: 5
• useSequenceNumber: boolean
  Title: useSequenceNumber

  Indicates whether the randomization list includes a sequence number.

  Example: false

{
    "title":"RndListDesignList",
    "type":"object",
    "properties":{
        "randListId":{
            "type":"string",
            "description":"Unique ID for randomization list.",
            "format":"uuid"
        },
        "randListName":{
            "type":"string",
            "description":"Randomization list name",
            "example":"UPL_RL191_V1001"
        },
        "randomizationSeed":{
            "title":"Randomization Seed",
            "type":"number",
            "description":"Seed number.",
            "format":"double",
            "example":5
        },
        "useSequenceNumber":{
            "title":"useSequenceNumber",
            "type":"boolean",
            "description":"Indicates whether the randomization list includes a sequence number.",
            "example":false
        },
        "randDesigns":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RndListDesign"
            }
        }
    },
    "description":"Contains randomization list with associated randomization designs."
}

Nested Schema : randDesigns

Type: array

Show Source

• Array of: object RndListDesign
  Title: RndListDesign

  Contains Randomization design detail.

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

Nested Schema : RndListDesign

Type: object

Title: RndListDesign

Contains Randomization design detail.

Show Source

• randDesignName: string
  Randomization design name

  Example: UPL_RL191_V1001
• randDesignSrcId: string (uuid)
  Unique ID for randomization design.
• studyVersion: string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 1.0.0.1

{
    "title":"RndListDesign",
    "type":"object",
    "properties":{
        "randDesignSrcId":{
            "type":"string",
            "description":"Unique ID for randomization design.",
            "format":"uuid"
        },
        "randDesignName":{
            "type":"string",
            "description":"Randomization design name",
            "example":"UPL_RL191_V1001"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"1.0.0.1"
        }
    },
    "description":"Contains Randomization design detail.",
    "example":{
        "randDesignId":"8ECE2C9D389645B09740DC7926DEFB69",
        "randDesignName":"Design A"
    }
}

Example:

{
    "randDesignId":"8ECE2C9D389645B09740DC7926DEFB69",
    "randDesignName":"Design A"
}

Examples

Select an example Get Randomization List Designs Response

404 Response

For invalid study ID or version

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 Get Randomization List Designs 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 Get Randomization List Designs Server Error Response

Back to Top