Jump to

• Request
• Response

v1.0

post

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

Retrieves treatment arms for a list of subjects in a study, passed in the request body. Rights: DataCaptureSubjectGet.

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : SubjectsRequest v1.0

Type: object

Title: SubjectsRequest v1.0

Contains subject IDs to process.

Show Source

• subjects(required): array Subjects
  Title: Subjects

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of subject IDs.

{
    "title":"SubjectsRequest v1.0",
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "title":"Subjects",
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"List of subject IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains subject IDs to process."
}

Nested Schema : Subjects

Type: array

Title: Subjects

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of subject IDs.

Show Source

• Array of: string(uuid)

{
    "title":"Subjects",
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"List of subject IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Select an example Subject Treatment Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SubjectTrtArmResponse v1.0

Type: object

Title: SubjectTrtArmResponse v1.0

Response object containing subject treatment.

Show Source

• subjectId: string (uuid)
  Title: Subject ID

  Subject ID.
• treatmentId: string (uuid)
  Title: Treatment ID

  Treatment ID.

{
    "title":"SubjectTrtArmResponse v1.0",
    "type":"object",
    "properties":{
        "subjectId":{
            "title":"Subject ID",
            "type":"string",
            "description":"Subject ID.",
            "format":"uuid"
        },
        "treatmentId":{
            "title":"Treatment ID",
            "type":"string",
            "description":"Treatment ID.",
            "format":"uuid"
        }
    },
    "description":"Response object containing subject treatment."
}

Examples

Select an example Subject Treatment Request Response

404 Response

Invalid study ID or version. Or subject 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

Examples

Select an example Subject Treatment Request 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 Subject Treatment Request Server Error Response

Back to Top