REST API for Clinical One Platform

Create manual shipment in resupply strategy

post

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/manual

Creates a manual shipment as part of a study's predictive resupply group. Rights: OrsSupplyManagerPost.

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 : ManualSupplyRequest v1.0

Type: object

Title: ManualSupplyRequest v1.0

Manual supply request object.

Show Source

jobInstanceId: string

Job instance Id.

Example: 4FEBE3E166454E2687C6FAC306E7C86E
kits: array kits

Minimum Number of Items: 1

Maximum Number of Items: 2147483647
siteId(required): string (uuid)

Site ID

{
    "title":"ManualSupplyRequest v1.0",
    "required":[
        "siteId"
    ],
    "type":"object",
    "properties":{
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance Id.",
            "example":"4FEBE3E166454E2687C6FAC306E7C86E"
        },
        "kits":{
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitRequest"
            }
        },
        "siteId":{
            "type":"string",
            "description":"Site ID",
            "format":"uuid"
        }
    },
    "description":"Manual supply request object."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

Array of: object KitRequest

Kit request object.

{
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KitRequest"
    }
}

Nested Schema : KitRequest

Type: object

Kit request object.

Show Source

kitTypeId: string (uuid)

ID of the kit type.
quantity: string

Kit quantity

Example: 2

{
    "type":"object",
    "properties":{
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "quantity":{
            "type":"string",
            "description":"Kit quantity",
            "example":"2"
        }
    },
    "description":"Kit request object."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object ManualResupplyResponse

Manual resupply response object.

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

Nested Schema : ManualResupplyResponse

Type: object

Manual resupply response object.

Show Source

orderId: string (uuid)

Order Id
shipmentNumber: string

Shipment number.

Example: 123
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"
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment number.",
            "example":"123"
        },
        "status":{
            "type":"string",
            "description":"Order status.",
            "example":"DESTROYED",
            "enum":[
                "PENDING",
                "INTRANSIT",
                "RECEIVED",
                "CANCELLED",
                "LOST",
                "CONFIRMED",
                "INVALID",
                "PENDING_DESTRUCTION",
                "RECEIVED_FOR_DESTRUCTION",
                "DESTROYED"
            ]
        }
    },
    "description":"Manual resupply response object."
}

404 Response

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

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