REST API for Clinical One Platform

Create shipment for kits marked for destruction from a given site to depot

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments

Retrieves a list of resupply orders where each order contains an order ID and an order status. In the request body, kitRange should have the following format: KIT_NUMBER:min:max. Rights: OrsInventoryPost and either SourceDataVerification or OrsUnblinded.

Request

Path Parameters

mode(required): string

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

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

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Request object to create a reconciliation shipment

Show Source

kits: array kits

Contains kits Ids.
kitsFilter: object ReconShipmentKitsFilter

Contains filters for kits for a reconciliation shipment
unblinded: boolean

Indicate if unblinded or blinded.

Example: true

{
    "type":"object",
    "properties":{
        "kits":{
            "type":"array",
            "description":"Contains kits Ids.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/ReconShipmentKitsFilter"
        },
        "unblinded":{
            "type":"boolean",
            "description":"Indicate if unblinded or blinded.",
            "example":true
        }
    },
    "description":"Request object to create a reconciliation shipment"
}

Nested Schema : kits

Type: array

Contains kits Ids.

Show Source

Array of: string(uuid)

{
    "type":"array",
    "description":"Contains kits Ids.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : ReconShipmentKitsFilter

Type: object

Contains filters for kits for a reconciliation shipment

Show Source

inventoryStatusIds: array inventoryStatusIds

Contains inventory status Ids.
kitRange: string (KIT_NUMBER:XXX:XXX)

Range of kit numbers.

Example: KIT_NUMBER:10:100
searchString: string

Search string for kits.

Example: Some search string
subjectId: string (uuid)

ID of the subject

{
    "type":"object",
    "properties":{
        "kitRange":{
            "type":"string",
            "description":"Range of kit numbers.",
            "format":"KIT_NUMBER:XXX:XXX",
            "example":"KIT_NUMBER:10:100"
        },
        "searchString":{
            "type":"string",
            "description":"Search string for kits.",
            "example":"Some search string"
        },
        "inventoryStatusIds":{
            "type":"array",
            "description":"Contains inventory status Ids.",
            "items":{
                "type":"number",
                "format":"Integer",
                "example":"5"
            }
        },
        "subjectId":{
            "type":"string",
            "description":"ID  of the subject",
            "format":"uuid"
        }
    },
    "description":"Contains filters for kits for a reconciliation shipment"
}

Nested Schema : inventoryStatusIds

Type: array

Contains inventory status Ids.

Show Source

Array of: number(Integer)

Example: 5

{
    "type":"array",
    "description":"Contains inventory status Ids.",
    "items":{
        "type":"number",
        "format":"Integer",
        "example":"5"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object ResupplyResponse

Response object containing resupply details.

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

Nested Schema : ResupplyResponse

Type: object

Response object containing resupply details.

Show Source

orderId: string (uuid)

Order Id
status: string

Allowed Values: [ "PENDING", "INTRANSIT", "RECEIVED", "CANCELLED", "LOST", "CONFIRMED", "INVALID", "PENDING_DESTRUCTION", "RECEIVED_FOR_DESTRUCTION", "DESTROYED" ]

Order status.

Example: DESTROYED

{
    "type":"object",
    "properties":{
        "orderId":{
            "type":"string",
            "description":"Order Id",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"Order status.",
            "example":"DESTROYED",
            "enum":[
                "PENDING",
                "INTRANSIT",
                "RECEIVED",
                "CANCELLED",
                "LOST",
                "CONFIRMED",
                "INVALID",
                "PENDING_DESTRUCTION",
                "RECEIVED_FOR_DESTRUCTION",
                "DESTROYED"
            ]
        }
    },
    "description":"Response object containing resupply details."
}

400 Response

'Kit reconciliation required was not set.','You can't update the status of this kit because the kit was sent to a depot.','You can't update the status of this kit because it's at a site that you don't have access to. Work with your clinical research associate or a clinical supply manager to update the kit.','Reconciliation shipment is not allowed as site has drug destruction capability.','Reconciliation shipment cannot be created as none of the depots have drug destruction capability.','Update kits cannot have both the kit identifiers list and the kits filter set.','Update kits must have either the kit identifiers list or the kits filter set.','Invalid inventory status transition.','Invalid kit at site.', 'Invalid kit range filter.', 'Subject ID is required.','Invalid subject.', 'Update kits no rows were found to update.','Update kits retrieved size of exceeds maximum rows for update limit of.','Update kits retrieve error, the following kit identifiers were not found.'

Root 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 : details

Type: object

404 Response

Site ID not found in site service.

Root 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 : details

Type: object

500 Response

Internal server error

Root 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 : details

Type: object