Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randnumberstatuses

Retrieves random number statuses. Rights: OrsRandListGet.

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

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 Random Number Statuses Response
  Title: Random Number Statuses Response

  Contains Random number status detail.

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

Nested Schema : Random Number Statuses Response

Type: object

Title: Random Number Statuses Response

Contains Random number status detail.

Show Source

• id: integer (int64)
  Title: ID

  Unique ID.

  Example: 10
• randNumberStatus: string
  Title: Random Number Status

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

  Random Number status.

  Example: Available

{
    "title":"Random Number Statuses Response",
    "type":"object",
    "properties":{
        "randNumberStatus":{
            "title":"Random Number Status",
            "type":"string",
            "description":"Random Number status.",
            "example":"Available",
            "enum":[
                "Unapproved",
                "Available",
                "Inactive",
                "Assigned",
                "Randomized in error"
            ]
        },
        "id":{
            "title":"ID",
            "type":"integer",
            "description":"Unique ID.",
            "format":"int64",
            "example":10
        }
    },
    "description":"Contains Random number status detail."
}

Examples

Select an example Get Random Number Statuses 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 Random Number Statuses Server Error Response

Back to Top