REST API for Clinical One Platform

Update a kit's barcode

put

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/barcode

Updates a kit's barcode. Rights: OrsInventoryPost and OrsUnblinded.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object KitNumberBarcodeTO

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

Nested Schema : KitNumberBarcodeTO

Type: object

Show Source

barcode(required): string

Minimum Length: 0

Maximum Length: 1000

barcode of the kit

Example: 61234
kitNumber(required): string

kitNumber of the kit in UTF-8

Example: Kit-5

{
    "required":[
        "barcode",
        "kitNumber"
    ],
    "type":"object",
    "properties":{
        "barcode":{
            "maxLength":1000,
            "minLength":0,
            "type":"string",
            "description":"barcode of the kit",
            "example":"61234"
        },
        "kitNumber":{
            "type":"string",
            "description":"kitNumber of the kit in UTF-8",
            "example":"Kit-5"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : InventoryUpdatedTO v1.0

Type: object

Title: InventoryUpdatedTO v1.0

object containing number of barcodes updated

Show Source

inventoryUpdated: number (double)

Maximum number of subjects who can be randomized for the study.

Example: 5

{
    "title":"InventoryUpdatedTO v1.0",
    "type":"object",
    "properties":{
        "inventoryUpdated":{
            "type":"number",
            "description":"Maximum number of subjects who can be randomized for the study.",
            "format":"double",
            "example":5
        }
    },
    "description":"object containing number of barcodes updated"
}

400 Response

Invalid Inventory Status

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

404 Response

Invalid study ID or version OR Study not found OR Inventory not found

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

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