Jump to

• Request
• Response

v3.0

post

/ec-ors-svc/rest/v3.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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ManualSupplyRequest v2.0

Type: object

Title: ManualSupplyRequest v2.0

Request containing manual supply details.

Show Source

• jobInstanceId: string
  Title: Job Instance ID

  Job instance ID.

  Example: 4FEBE3E166454E2687C6FAC306E7C86E
• kits: array kits
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647
• siteId(required): string (uuid)
  Title: Site ID

  Site ID.

{
    "title":"ManualSupplyRequest v2.0",
    "required":[
        "siteId"
    ],
    "type":"object",
    "properties":{
        "jobInstanceId":{
            "title":"Job Instance ID",
            "type":"string",
            "description":"Job instance ID.",
            "example":"4FEBE3E166454E2687C6FAC306E7C86E"
        },
        "siteId":{
            "title":"Site ID",
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        },
        "kits":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitRequestV2"
            }
        }
    },
    "description":"Request containing manual supply details."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object KitRequest v2.0
  Title: KitRequest v2.0

  Request containing kits details.

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

Nested Schema : KitRequest v2.0

Type: object

Title: KitRequest v2.0

Request containing kits details.

Show Source

• kitTypeId: string (uuid)
  Title: Kit Type ID

  Kit type identifier.
• lotId: string (uuid)
  Title: Blinded Lot ID

  Blinded lot ID.
• quantity(required): number
  Title: Quantity

  Minimum Value: 0

  Minimum Value: > false

  Maximum Value: 999

  Maximum Value: < false

  Kit quantity.

  Example: 2

{
    "title":"KitRequest v2.0",
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "quantity":{
            "title":"Quantity",
            "maximum":999,
            "exclusiveMaximum":false,
            "minimum":0,
            "exclusiveMinimum":false,
            "type":"number",
            "description":"Kit quantity.",
            "example":2
        },
        "lotId":{
            "title":"Blinded Lot ID",
            "type":"string",
            "description":"Blinded lot ID.",
            "format":"uuid"
        }
    },
    "description":"Request containing kits details."
}

Examples

Select an example Create Manual Shipment Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ManualResupplyResponse
  Title: ManualResupplyResponse

  Manual resupply response object.

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

Nested Schema : ManualResupplyResponse

Type: object

Title: ManualResupplyResponse

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

{
    "title":"ManualResupplyResponse",
    "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."
}

Examples

Select an example Create Manual Shipment Response

404 Response

Not found

Body ()

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

Examples

Select an example Create Manual Shipment Not Found Response

500 Response

Internal server error

Body ()

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

Examples

Select an example Create Manual Shipment Server Error Response

Back to Top