REST API for Clinical One Platform

Get kits eligible to be received against a shipment

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/eligible-kits

Retrieves all kits eligible to be received against a shipment. Rights: OrsSupplyManagerGet and OrsBlinded.

Request

Path Parameters

mode(required): string

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

ID of the shipment.
siteId(required): string

ID of the site
studyId(required): string(uuid)

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ShipmentRecvEligibleKitsResponse

Type: object

Response object containing eligible kits of a received shipment.

Show Source

kits: array kits
shipmentId: string (uuid)

ID of the shipment.

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentEligibleKitTOV1"
            }
        }
    },
    "description":"Response object containing eligible kits of a received shipment."
}

Nested Schema : kits

Type: array

Show Source

Array of: object ShipmentEligibleKitTO v1.0

Title: ShipmentEligibleKitTO v1.0

Contains kit details belonging to shipment.

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

Nested Schema : ShipmentEligibleKitTO v1.0

Type: object

Title: ShipmentEligibleKitTO v1.0

Contains kit details belonging to shipment.

Show Source

expirationDate: string (date-time)

Expiration date
id: string (uuid)

Inventory Id.
kitNumber: number (double)

Kit/Lot number

Example: 5
kitTypeName: string

Kit type name.

Example: Kit A
sequenceNumber: number (double)

Sequence number.

Example: 5

{
    "title":"ShipmentEligibleKitTO v1.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit/Lot number",
            "format":"double",
            "example":5
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "description":"Inventory Id.",
            "format":"uuid"
        }
    },
    "description":"Contains kit details belonging to shipment."
}

400 Response

Invalid shipment type

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.

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID'

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.

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.