Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits

Assign Pooling Shipment kits in a study's inventory. Rights: OrsInventoryPost and DepotShipmentReceiptPost/OrsBlinded.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• shipmentNumber(required): string
  Pooling shipment number.

  Example:

  SHIP-POOL-001

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : PoolingShipmentRequest v1.0

Type: object

Title: PoolingShipmentRequest v1.0

Request containing pooling shipment details.

Show Source

• deliveryNumber: string
  Title: Delivery Number

  Delivery number.

  Example: 88888
• kits(required): array Kits
  Title: Kits

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of pooling kits.
• shipDate(required): string
  Title: Ship Date

  Pattern: (\d){2}-[a-zA-Z]{3}-(\d){4}

  Ship date.

  Example: 12-May-2023
• shipmentNumber: string
  Title: Shipment Number

  Shipment number.

  Example: Site1
• trackingNumber: string
  Title: Tracking Number

  Shipment tracking number.

  Example: 123456

{
    "title":"PoolingShipmentRequest v1.0",
    "required":[
        "kits",
        "shipDate"
    ],
    "type":"object",
    "properties":{
        "shipDate":{
            "title":"Ship Date",
            "pattern":"(\\d){2}-[a-zA-Z]{3}-(\\d){4}",
            "type":"string",
            "description":"Ship date.",
            "example":"12-May-2023"
        },
        "kits":{
            "title":"Kits",
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"List of pooling kits.",
            "items":{
                "$ref":"#/components/schemas/PoolingKits"
            }
        },
        "trackingNumber":{
            "title":"Tracking Number",
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"123456"
        },
        "deliveryNumber":{
            "title":"Delivery Number",
            "type":"string",
            "description":"Delivery number.",
            "example":"88888"
        },
        "shipmentNumber":{
            "title":"Shipment Number",
            "type":"string",
            "description":"Shipment number.",
            "example":"Site1"
        }
    },
    "description":"Request containing pooling shipment details."
}

Nested Schema : Kits

Type: array

Title: Kits

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of pooling kits.

Show Source

• Array of: object PoolingKits v1.0
  Title: PoolingKits v1.0

  Object containing Kit details

{
    "title":"Kits",
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"List of pooling kits.",
    "items":{
        "$ref":"#/components/schemas/PoolingKits"
    }
}

Nested Schema : PoolingKits v1.0

Type: object

Title: PoolingKits v1.0

Object containing Kit details

Show Source

• barcode: string
  Barcode.

  Example: 61234
• blockNumber: string
  Title: Block Number

  Block number.

  Example: 5
• itemNumber: string
  Title: Item Number

  Item number.

  Example: i
• kitNumber(required): string
  Title: Kit Number

  Kit number.

  Example: 5
• manufacturingLotNumber(required): string
  Title: Manufacturing Lot Number

  Manufacturing lot number.

  Example: Lot A
• poolingId: string
  Title: Pooling ID

  Pooling ID.

  Example: PooledKitA
• sequenceNumber(required): number (BigDecimal)
  Sequence number.

  Example: 5

{
    "title":"PoolingKits v1.0",
    "required":[
        "kitNumber",
        "manufacturingLotNumber",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"BigDecimal",
            "example":5
        },
        "kitNumber":{
            "title":"Kit Number",
            "type":"string",
            "description":"Kit number.",
            "example":"5"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode.",
            "example":"61234"
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"string",
            "description":"Block number.",
            "example":"5"
        },
        "poolingId":{
            "title":"Pooling ID",
            "type":"string",
            "description":"Pooling ID.",
            "example":"PooledKitA"
        },
        "manufacturingLotNumber":{
            "title":"Manufacturing Lot Number",
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"Lot A"
        },
        "itemNumber":{
            "title":"Item Number",
            "type":"string",
            "description":"Item number.",
            "example":"i"
        }
    },
    "description":"Object containing Kit details",
    "example":{
        "kitNumber":"KIT-000123",
        "poolingGroupId":"2"
    }
}

Example:

{
    "kitNumber":"KIT-000123",
    "poolingGroupId":"2"
}

Examples

Select an example Assign Pooling Shipment Kits Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : PoolingShipmentResponse v1.0

Type: object

Title: PoolingShipmentResponse v1.0

Response object containing pooling shipment details.

Show Source

• shipmentId: string (uuid)
  Shipment ID.

{
    "title":"PoolingShipmentResponse v1.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment ID.",
            "format":"uuid"
        }
    },
    "description":"Response object containing pooling shipment details."
}

Examples

Select an example Assign Pooling Shipment Kits Response

400 Response

'Invalid shipment

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Bad Request

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID', 'Invalid site ID'

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Not Found

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples

Select an example Server Error

Back to Top