REST API for Clinical One Platform

Get a shipment's details by ID for a site

get

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

Retrieves a shipments' details by ID for a site. 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(uuid)

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 : SiteUserShipmentTOV2

Type: object

Response object containing details about shipment at a site.

Show Source

availableCount: integer (int64)

Available kits count.

Example: 5
createdDate: string (date-time)

Shipment creation date
damagedCount: integer (int64)

Damaged kits count.

Example: 5
depotId: string (uuid)

Depot Id
depotName: string

Name of the depot.

Example: Depot Houston
depotShortName: string

Short identifier for the depot, such as a number.

Example: 123
inTransitCount: integer (int64)

In transit kits count.

Example: 5
missingCount: integer (int64)

Missing kits count.

Example: 5
preQuarantinedCount: integer (int64)

Pre quarantined kits count.

Example: 5
reconciliation: boolean

Indicate if kit reconciliation is there.

Example: true
reportId: string

Report Id.

Example: B1B8327AFAA6412287106192AB5984EF
shipDate: string (date-time)

Ship date.
shipmentId: string

ID of the shipment.

Example: 123
shipmentNumber: string

Shipment number.

Example: 123
siteId: string (uuid)

ID of the site
siteName: string

Name of the site.

Example: Site Houston
siteShortName: string

Short identifier for the site, such as a number.

Example: 12
statusDate: string (date-time)

Status date.
statusId: number (Integer)

Shipment status Id.

Example: 5
trackingNumber: string

Shipment tracking number.

Example: 12345
trackingNumberURL: string

Shipment tracking url.

Example: http://www.site.com

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"123"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteName":{
            "type":"string",
            "description":"Name of the site.",
            "example":"Site Houston"
        },
        "siteShortName":{
            "type":"string",
            "description":"Short identifier for the site, such as a number.",
            "example":"12"
        },
        "depotId":{
            "type":"string",
            "description":"Depot Id",
            "format":"uuid"
        },
        "depotName":{
            "type":"string",
            "description":"Name of the depot.",
            "example":"Depot Houston"
        },
        "depotShortName":{
            "type":"string",
            "description":"Short identifier for the depot, such as a number.",
            "example":"123"
        },
        "statusId":{
            "type":"number",
            "description":"Shipment status Id.",
            "format":"Integer",
            "example":5
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"123"
        },
        "createdDate":{
            "type":"string",
            "description":"Shipment creation date",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "statusDate":{
            "type":"string",
            "description":"Status 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
        },
        "inTransitCount":{
            "type":"integer",
            "description":"In transit kits count.",
            "format":"int64",
            "example":5
        },
        "reportId":{
            "type":"string",
            "description":"Report Id.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "reconciliation":{
            "type":"boolean",
            "description":"Indicate if kit reconciliation is there.",
            "example":true
        },
        "trackingNumberURL":{
            "type":"string",
            "description":"Shipment tracking url.",
            "example":"http://www.site.com"
        }
    },
    "description":"Response object containing details about shipment at a site."
}

404 Response

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

Root Schema : DesignerResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : DesignerResponse

Type: object

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : Object

Type: object

Title: Object

Object with error details information.