REST API for Clinical One Platform

Mark shipments as lost

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/mark-lost

Marks shipments as Lost in the system. Rights: OrsSupplyManagerPost, OrsUnblinded.

Request

Path Parameters

mode(required): string

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

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Request object containing lost shipment details.

Show Source

shipmentIds(required): array shipmentIds

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains shipments Ids.

{
    "required":[
        "shipmentIds"
    ],
    "type":"object",
    "properties":{
        "shipmentIds":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "description":"Contains shipments Ids.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Request object containing lost shipment details."
}

Nested Schema : shipmentIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains shipments Ids.

Show Source

Array of: string(uuid)

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "description":"Contains shipments Ids.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

400 Response

'Invalid order status' or 'Invalid shipment type'

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

404 Response

Invalid study ID, 'Study still in design phase', '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