REST API for Clinical One Platform

Update tracking details for an order shipment

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/tracking

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

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)

ID of the study

Supported Media Types

Root Schema : schema

Type: object

Shipment tracking details request object.

Show Source

shipmentId: string (uuid)

Shipment Id.
trackingNumber: string

Minimum Length: 0

Maximum Length: 50

Shipment tracking number.

Example: 12345
trackingNumberUrl: string

Minimum Length: 0

Maximum Length: 2048

Pattern: ^$|^(https?)://.+$

Tracking number url.

Example: http://www.site.com

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment Id.",
            "format":"uuid"
        },
        "trackingNumber":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "trackingNumberUrl":{
            "maxLength":"2048",
            "minLength":"0",
            "pattern":"^$|^(https?)://.+$",
            "type":"string",
            "description":"Tracking number url.",
            "example":"http://www.site.com"
        }
    },
    "description":"Shipment tracking details request object."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: string(uuid)

404 Response

'Invalid study ID', 'Study still in design phase' or 'Invalid shipment ID'

Root Schema : DesignerResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

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

Nested Schema : details

Type: object

500 Response

Internal server error

Root Schema : DesignerResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

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

Nested Schema : details

Type: object