Jump to

• Request
• Response

v1.0

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks

Updates randomization list blocks in a study. Rights: OrsRandListPost, OrsUnblinded.

Request

Path Parameters

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

  Example:

  test

• rndlistid(required): string(uuid)
  ID of the randomization list.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Request object to create randomization list block.

Show Source

• blocks(required): array blocks
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

{
    "required":[
        "blocks"
    ],
    "type":"object",
    "properties":{
        "blocks":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "example":[
                {
                    "blockSize":4,
                    "blockCount":10
                }
            ],
            "items":{
                "$ref":"#/components/schemas/RndListBlockRequest"
            }
        }
    },
    "description":"Request object to create randomization list block."
}

Nested Schema : blocks

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object Randomization List Block Request
  Title: Randomization List Block Request

  Randomization block request object.

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "example":[
        {
            "blockSize":4,
            "blockCount":10
        }
    ],
    "items":{
        "$ref":"#/components/schemas/RndListBlockRequest"
    }
}

Example:

[
    {
        "blockSize":4,
        "blockCount":10
    }
]

Nested Schema : Randomization List Block Request

Type: object

Title: Randomization List Block Request

Randomization block request object.

Show Source

• block(required): integer (int32)
  Block number.

  Example: 5
• blockedBy(required): string
  Blocked by site, country, etc.

  Example: Site1001

{
    "title":"Randomization List Block Request",
    "required":[
        "block",
        "blockedBy"
    ],
    "type":"object",
    "properties":{
        "block":{
            "type":"integer",
            "description":"Block number.",
            "format":"int32",
            "example":5
        },
        "blockedBy":{
            "type":"string",
            "description":"Blocked by site, country, etc.",
            "example":"Site1001"
        }
    },
    "description":"Randomization block request object.",
    "example":{
        "blockSize":4,
        "blockCount":10
    }
}

Example:

{
    "blockSize":4,
    "blockCount":10
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

Examples

Select an example Update Randomization List Blocks Response

400 Response

For a dynamic algorithm, you can't assign blocks to a blocked parameter. Or invalid blocked by value.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Update Randomization List Blocks Bad Request Response

404 Response

For Invalid study ID or version or randomization List not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Update Randomization List Blocks Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Update Randomization List Blocks Server Error Response

Back to Top