REST API for Clinical One Cloud Service

v2.0

post

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak

Retrieves code break. Rights: OrsSubjectVisitGet.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
srcSubjectId(required): string(uuid)
Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.
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

application/json

Root Schema : Code View Request

Type: object

Title: Code View Request

Contains code view request details.

Show Source

adverseEvent(required): integer (int32)

Minimum Value: 0

Maximum Value: 1

Allowed Values: [ 0, 1 ]

Adverse event.

Example: 1

{
    "title":"Code View Request",
    "required":[
        "adverseEvent"
    ],
    "type":"object",
    "properties":{
        "adverseEvent":{
            "maximum":1,
            "minimum":0,
            "type":"integer",
            "description":"Adverse event.",
            "format":"int32",
            "example":1,
            "enum":[
                0,
                1
            ]
        }
    },
    "description":"Contains code view request details."
}

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : Code View Response

Type: object

Title: Code View Response

Contains code view response details.

Show Source

kitTypes: array Kit Types

Title: Kit Types

Contains kit type details.
treatmentArms: array Treatment Arms

Title: Treatment Arms

Contains treatment arm details.

{
    "title":"Code View Response",
    "type":"object",
    "properties":{
        "treatmentArms":{
            "title":"Treatment Arms",
            "type":"array",
            "description":"Contains treatment arm details.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "description":"Randomized successfully",
                    "externalTreatmentId":"TA",
                    "randNumber":1001,
                    "randomizationDate":"2025-01-01T12:34:56Z",
                    "rndStatusId":5
                }
            ],
            "items":{
                "$ref":"#/components/schemas/RandomizationHistoryTO"
            }
        },
        "kitTypes":{
            "title":"Kit Types",
            "type":"array",
            "description":"Contains kit type details.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "kitTypeName":"Kit A",
                    "description":"Non dosing kit",
                    "packageTypeId":5,
                    "packageType":"BOTTLE"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/CodeViewResponse.KitTypes"
            }
        }
    },
    "description":"Contains code view response details."
}

Nested Schema : Kit Types

Type: array

Title: Kit Types

Contains kit type details.

Show Source

Array of: object CodeViewResponse.KitTypes

Kit type details object.

{
    "title":"Kit Types",
    "type":"array",
    "description":"Contains kit type details.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "kitTypeName":"Kit A",
            "description":"Non dosing kit",
            "packageTypeId":5,
            "packageType":"BOTTLE"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/CodeViewResponse.KitTypes"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitTypeName":"Kit A",
        "description":"Non dosing kit",
        "packageTypeId":5,
        "packageType":"BOTTLE"
    }
]

Nested Schema : Treatment Arms

Type: array

Title: Treatment Arms

Contains treatment arm details.

Show Source

Array of: object RandomizationHistoryTO

Title: RandomizationHistoryTO

Contains subject randomization history details.

{
    "title":"Treatment Arms",
    "type":"array",
    "description":"Contains treatment arm details.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "description":"Randomized successfully",
            "externalTreatmentId":"TA",
            "randNumber":1001,
            "randomizationDate":"2025-01-01T12:34:56Z",
            "rndStatusId":5
        }
    ],
    "items":{
        "$ref":"#/components/schemas/RandomizationHistoryTO"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "description":"Randomized successfully",
        "externalTreatmentId":"TA",
        "randNumber":1001,
        "randomizationDate":"2025-01-01T12:34:56Z",
        "rndStatusId":5
    }
]

Nested Schema : CodeViewResponse.KitTypes

Type: object

Kit type details object.

Show Source

description: string

Kit type description.

Example: Non dosing kit
dispensationDetails: array dispensationDetails

Dispensation details for the kit type.
id: string

ID of the kit type.

Example: B1B8327AFAA6412287106192AB5984EF
kitTypeName: string

Kit type name.

Example: Kit A
packageType: string

Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

Package type.

Example: INHALER
packageTypeId: number (double)

Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

Example: 5

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "packageType":{
            "type":"string",
            "description":"Package type.",
            "example":"INHALER",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "dispensationDetails":{
            "type":"array",
            "description":"Dispensation details for the kit type.",
            "example":[
                {
                    "lotId":"B1B8327AFAA6412287106192AB5984EF",
                    "lotNumber":"LOT-001",
                    "quantity":5
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DispensationHistoryResponseV4"
            }
        }
    },
    "description":"Kit type details object.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "kitTypeName":"Kit A",
        "description":"Non dosing kit",
        "packageTypeId":5,
        "packageType":"BOTTLE"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "kitTypeName":"Kit A",
    "description":"Non dosing kit",
    "packageTypeId":5,
    "packageType":"BOTTLE"
}

Nested Schema : dispensationDetails

Type: array

Dispensation details for the kit type.

Show Source

Array of: object DispensationHistoryResponse v4.0

Title: DispensationHistoryResponse v4.0

Response object containing Dispensation History.

{
    "type":"array",
    "description":"Dispensation details for the kit type.",
    "example":[
        {
            "lotId":"B1B8327AFAA6412287106192AB5984EF",
            "lotNumber":"LOT-001",
            "quantity":5
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DispensationHistoryResponseV4"
    }
}

Example:

[
    {
        "lotId":"B1B8327AFAA6412287106192AB5984EF",
        "lotNumber":"LOT-001",
        "quantity":5
    }
]

Nested Schema : DispensationHistoryResponse v4.0

Type: object

Title: DispensationHistoryResponse v4.0

Response object containing Dispensation History.

Show Source

balanceUnits: number (double)

Title: Balance Units

Balanced units for the kit.

Example: 1
deviceConnection: string

Title: Device Connection Type

Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

Device connection type.

Example: DevicetoCloud
deviceType: string

Title: Device Type

Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

Device type.

Example: WearablePatch
dispensationDate: string (date-time)

Title: Dispensation Date

Dispensation date.
dose: number (double)

Title: Dose

Dose.

Example: 5
frequency: string

Title: Frequency

Allowed Values: [ "Once", "QD", "BID", "TID", "QID", "Q3", "Q4", "Q8", "Q12", "Q24", "Bedtime", "With meals", "With meals and at bedtime" ]

Dosing frequency.

Example: BID
inventoryId: string (uuid)

Title: Inventory ID

Inventory ID.
inventoryStatus: number (double)

Title: Inventory Status

Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

Example: 5
kitDescription: string

Title: Kit Description

Kit description.

Example: Kit A
kitNumber: number (double)

Title: Kit Number

Kit number.

Example: 5
lastModifiedDate: string (date-time)

Title: Last Modified Date

Last modified date.
measurement: string

Title: Measurement

Dose Measurement.

Example: ml
mHealthDeviceId: string

Title: mHealth Device ID

mHealth device identifier.

Example: B1B8327AFAA6412287106192AB5984EF
missingUnits: number (double)

Title: Missing Units

Missing units for the kit.

Example: 1
packageTypeId: number (double)

Title: Package Type ID

Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

Package type ID.

Example: 5
returnedUnits: number (double)

Title: Returned Units

Returned units for the kit.

Example: 1
siteId: string (uuid)

Title: Site ID

Site ID.
trialSupplyType: string

Title: Trial Supply Type

Type of the trial supply.

Example: BOTTLE
unitsPerKit: number (double)

Title: Units Per Kit

Units per kit.

Example: 1
visitId: string (uuid)

Title: Visit ID

Visit ID.

{
    "title":"DispensationHistoryResponse v4.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "inventoryStatus":{
            "title":"Inventory Status",
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "dispensationDate":{
            "title":"Dispensation Date",
            "type":"string",
            "description":"Dispensation date.",
            "format":"date-time"
        },
        "inventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "packageTypeId":{
            "title":"Package Type ID",
            "type":"number",
            "description":"Package type ID.",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "unitsPerKit":{
            "title":"Units Per Kit",
            "type":"number",
            "description":"Units per kit.",
            "format":"double",
            "example":1
        },
        "returnedUnits":{
            "title":"Returned Units",
            "type":"number",
            "description":"Returned units for the kit.",
            "format":"double",
            "example":1
        },
        "missingUnits":{
            "title":"Missing Units",
            "type":"number",
            "description":"Missing units for the kit.",
            "format":"double",
            "example":1
        },
        "balanceUnits":{
            "title":"Balance Units",
            "type":"number",
            "description":"Balanced units for the kit.",
            "format":"double",
            "example":1
        },
        "siteId":{
            "title":"Site ID",
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        },
        "lastModifiedDate":{
            "title":"Last Modified Date",
            "type":"string",
            "description":"Last modified date.",
            "format":"date-time"
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        },
        "dose":{
            "title":"Dose",
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":5
        },
        "measurement":{
            "title":"Measurement",
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "title":"Frequency",
            "type":"string",
            "description":"Dosing frequency.",
            "example":"BID",
            "enum":[
                "Once",
                "QD",
                "BID",
                "TID",
                "QID",
                "Q3",
                "Q4",
                "Q8",
                "Q12",
                "Q24",
                "Bedtime",
                "With meals",
                "With meals and at bedtime"
            ]
        },
        "visitId":{
            "title":"Visit ID",
            "type":"string",
            "description":"Visit ID.",
            "format":"uuid"
        },
        "trialSupplyType":{
            "title":"Trial Supply Type",
            "type":"string",
            "description":"Type of the trial supply.",
            "example":"BOTTLE"
        },
        "deviceType":{
            "title":"Device Type",
            "type":"string",
            "description":"Device type.",
            "example":"WearablePatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "title":"Device Connection Type",
            "type":"string",
            "description":"Device connection type.",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "mHealthDeviceId":{
            "title":"mHealth Device ID",
            "type":"string",
            "description":"mHealth device identifier.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Response object containing Dispensation History."
}

Nested Schema : RandomizationHistoryTO

Type: object

Title: RandomizationHistoryTO

Contains subject randomization history details.

Show Source

description: string

Treatment description

Example: Some description.
externalTreatmentId: string

External treatment ID.

Example: TxA
id: string (uuid)

Treatment ID
randNumber: number (double)

Randomization number.

Example: 5
randomizationDate: string (date-time)

Randomization date.

Example: 2025-01-01T12:34:56Z
rndStatusId: number (double)

Allowed Values: [ 1, 2, 3, 4, 5 ]

Randomization status ID.

Example: 5

{
    "title":"RandomizationHistoryTO",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Treatment ID",
            "format":"uuid"
        },
        "description":{
            "type":"string",
            "description":"Treatment description",
            "example":"Some description."
        },
        "externalTreatmentId":{
            "type":"string",
            "description":"External treatment ID.",
            "example":"TxA"
        },
        "randNumber":{
            "type":"number",
            "description":"Randomization number.",
            "format":"double",
            "example":5
        },
        "randomizationDate":{
            "type":"string",
            "description":"Randomization date.",
            "format":"date-time",
            "example":"2025-01-01T12:34:56Z"
        },
        "rndStatusId":{
            "type":"number",
            "description":"Randomization status ID.",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5
            ]
        }
    },
    "description":"Contains subject randomization history details.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "description":"Randomized successfully",
        "externalTreatmentId":"TA",
        "randNumber":1001,
        "randomizationDate":"2025-01-01T12:34:56Z",
        "rndStatusId":5
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "description":"Randomized successfully",
    "externalTreatmentId":"TA",
    "randNumber":1001,
    "randomizationDate":"2025-01-01T12:34:56Z",
    "rndStatusId":5
}

Examples

400 Response

For invalid parameters

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

404 Response

For invalid study ID or version. Or subject not found. Or site ID not found in site service

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

500 Response

Internal server error

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