Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/rndListsByRegion/regions/{regionId}

Checks whether a randomization design is blocked by region or not. Rights: RegionGet.

Request

Path Parameters

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

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

  Contains region rand list detail.

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

Nested Schema : RegionRandListTO

Type: object

Title: RegionRandListTO

Contains region rand list detail.

Show Source

• name: string
  Region name.

  Example: Asia, Europe
• randListId: string (uuid)
  Unique ID for randomization list.
• regionId: string (uuid)
  Unique ID for region.

{
    "title":"RegionRandListTO",
    "type":"object",
    "properties":{
        "regionId":{
            "type":"string",
            "description":"Unique ID for region.",
            "format":"uuid"
        },
        "randListId":{
            "type":"string",
            "description":"Unique ID for randomization list.",
            "format":"uuid"
        },
        "name":{
            "type":"string",
            "description":"Region name.",
            "example":"Asia, Europe"
        }
    },
    "description":"Contains region rand list detail."
}

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
• 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