REST API for Clinical One Platform

Update shipment details for an order with deliveryNumber

put

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

Updates shipment details with deliverNumber for an order Rights: OrsInventoryPost, OrsUnblinded.

Request

Path Parameters

mode(required): string

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

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

ID of the study

Supported Media Types

Root Schema : schema

Type: object

Contains shipment order details.

Show Source

deliveryNumber: string

Delivery number.

Example: 12345
shipDate(required): string (date-time)

Date of shipping.
trackingNumber(required): string

Tracking number.

Example: 12345
trackingNumberUrl: string

Tracking number url.

Example: http://www.site.com
updateDeliveryNumber: boolean

{
    "required":[
        "shipDate",
        "trackingNumber"
    ],
    "type":"object",
    "properties":{
        "shipDate":{
            "type":"string",
            "description":"Date of shipping.",
            "format":"date-time"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Tracking number.",
            "example":"12345"
        },
        "trackingNumberUrl":{
            "type":"string",
            "description":"Tracking number url.",
            "example":"http://www.site.com"
        },
        "deliveryNumber":{
            "type":"string",
            "description":"Delivery number.",
            "example":"12345"
        },
        "updateDeliveryNumber":{
            "type":"boolean"
        }
    },
    "description":"Contains shipment order details."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

400 Response

Invalid shipment type

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 design phase' or 'Invalid shipment 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