REST API for Clinical One Platform

v2.0

post

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received

Deprecated: Marks kits as received in a study's inventory. Rights: OrsInventoryPost and DepotShipmentReceiptPost/OrsBlinded.

Request

Path Parameters

mode(required): string

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

ID of the shipment.
studyId(required): string(uuid)

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

tempMonitorStatus: string

Allowed Values: [ "yes", "no", "missing" ]

Pattern: yes|no|missing

Temperature monitor status.

Example: yes
updateKits: object updateKits

Additional Properties Allowed: additionalProperties
updateNSKits: array updateNSKits

Contains non-serialized kits to be updated for received shipment.

{
    "type":"object",
    "properties":{
        "updateKits":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "updateNSKits":{
            "type":"array",
            "description":"Contains non-serialized kits to be updated for received shipment.",
            "items":{
                "$ref":"#/components/schemas/NSKitsRequest"
            }
        },
        "tempMonitorStatus":{
            "pattern":"yes|no|missing",
            "type":"string",
            "description":"Temperature monitor status.",
            "example":"yes",
            "enum":[
                "yes",
                "no",
                "missing"
            ]
        }
    }
}

Nested Schema : updateKits

Type: object

Additional Properties Allowed

Show Source

integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : updateNSKits

Type: array

Contains non-serialized kits to be updated for received shipment.

Show Source

Array of: object NSKitsRequest v1.0

Title: NSKitsRequest v1.0

Request containing non-serialized kits details.

{
    "type":"array",
    "description":"Contains non-serialized kits to be updated for received shipment.",
    "items":{
        "$ref":"#/components/schemas/NSKitsRequest"
    }
}

Nested Schema : NSKitsRequest v1.0

Type: object

Title: NSKitsRequest v1.0

Request containing non-serialized kits details.

Show Source

inventoryStatusId: integer (int32)

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: 10
kitTypeId: string (uuid)

Title: Kit Type ID

Kit type identifier.
lotId: string (uuid)

Title: Lot ID

Lot ID.
quantity(required): number (BigDecimal)

Title: Quantity

Minimum Value: 1

Kit quantity.

{
    "title":"NSKitsRequest v1.0",
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "inventoryStatusId":{
            "type":"integer",
            "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":"int32",
            "example":10
        },
        "quantity":{
            "title":"Quantity",
            "minimum":1,
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal"
        }
    },
    "description":"Request containing non-serialized kits details."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ShipmentReceivedResponse

Type: object

Title: ShipmentReceivedResponse

Received shipment details response object.

Show Source

availableCount: integer (int64)

Available kits count.

Example: 5
damagedCount: integer (int64)

Damaged kits count.

Example: 5
missingCount: integer (int64)

Missing kits count.

Example: 5
preQuarantinedCount: integer (int64)

Pre quarantined kits count.

Example: 5
receivedDate: string (date-time)

Shipment received date.
shipmentId: string (uuid)

ID of the shipment.

{
    "title":"ShipmentReceivedResponse",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "receivedDate":{
            "type":"string",
            "description":"Shipment received date.",
            "format":"date-time"
        },
        "damagedCount":{
            "type":"integer",
            "description":"Damaged kits count.",
            "format":"int64",
            "example":5
        },
        "missingCount":{
            "type":"integer",
            "description":"Missing kits count.",
            "format":"int64",
            "example":5
        },
        "preQuarantinedCount":{
            "type":"integer",
            "description":"Pre quarantined kits count.",
            "format":"int64",
            "example":5
        },
        "availableCount":{
            "type":"integer",
            "description":"Available kits count.",
            "format":"int64",
            "example":5
        }
    },
    "description":"Received shipment details response object."
}

400 Response

'Invalid order status', 'Invalid kit'

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', 'Study still in Draft (design phase)', 'Invalid shipment ID', 'Invalid site ID'

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