Jump to

• Request
• Response

v2.0

post

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

Adds kits to 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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Request object containing kits to be added to shipment.

Show Source

• kits(required): array kits
  Minimum Number of Items: 1

  Contains kit IDs
• nsKits: array nsKits
  Contains kit IDs.
• shipmentId: string (uuid)
  ID of the shipment.

{
    "required":[
        "kits"
    ],
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "kits":{
            "minItems":1,
            "type":"array",
            "description":"Contains kit IDs",
            "items":{
                "type":"string",
                "format":"uuid",
                "example":"e39ff55a-4455-43a3-8d51-3325664f0b2d"
            }
        },
        "nsKits":{
            "type":"array",
            "description":"Contains kit IDs.",
            "items":{
                "$ref":"#/components/schemas/ShipmentAddNonSerializedKitRequest"
            }
        }
    },
    "description":"Request object containing kits to be added to shipment."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Contains kit IDs

Show Source

• Array of: string(uuid)
  Example: e39ff55a-4455-43a3-8d51-3325664f0b2d

{
    "minItems":1,
    "type":"array",
    "description":"Contains kit IDs",
    "items":{
        "type":"string",
        "format":"uuid",
        "example":"e39ff55a-4455-43a3-8d51-3325664f0b2d"
    }
}

Nested Schema : nsKits

Type: array

Contains kit IDs.

Show Source

• Array of: object ShipmentAddNonSerializedKitRequest
  Request object containing non serialized kits to be added to shipment.

{
    "type":"array",
    "description":"Contains kit IDs.",
    "items":{
        "$ref":"#/components/schemas/ShipmentAddNonSerializedKitRequest"
    }
}

Nested Schema : ShipmentAddNonSerializedKitRequest

Type: object

Request object containing non serialized kits to be added to shipment.

Show Source

• kitTypeSrcId: string (uuid)
  ID OF THE KIT
• lotId: string (uuid)
  ID of the lot.
• quantity(required): number (BigDecimal)
  Minimum Value: 1

  Maximum Value: 9999

  Quantity of kits

  Example: 24

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "lotId":{
            "type":"string",
            "description":"ID of the lot.",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"ID OF THE KIT",
            "format":"uuid"
        },
        "quantity":{
            "maximum":9999,
            "minimum":1,
            "type":"number",
            "description":"Quantity of kits",
            "format":"BigDecimal",
            "example":24
        }
    },
    "description":"Request object containing non serialized kits to be added to shipment."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

404 Response

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

Body ()

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

Body ()

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

Back to Top