Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits

Removes kits from an order shipment. Rights: OrsInventoryDelete, OrsUnblinded.

Request

Path Parameters

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

  Example:

  test

• shipmentId(required): string(uuid)
  ID of the shipment.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Request object containing kits to be removed from shipment.

Show Source

• kits: array kits
  Minimum Number of Items: 1

  Kits to be removed from the shipment.
• nsKits: array nsKits
  Kits to be removed from the shipment.
• shipmentId: string (uuid)
  ID of the shipment.

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "kits":{
            "minItems":1,
            "type":"array",
            "description":"Kits to be removed from the shipment.",
            "example":[
                "E39FF55A445543A38D513325664F0B2D"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "nsKits":{
            "type":"array",
            "description":"Kits to be removed from the shipment.",
            "example":[
                {
                    "lotId":"C36A3197FDEE433FB5547EE83DE99E4B",
                    "kitTypeSrcId":"D313327EF13845169A8ADADDA435431E",
                    "quantity":56
                }
            ],
            "items":{
                "$ref":"#/components/schemas/ShipmentRemoveNonSerializedKitRequest"
            }
        }
    },
    "description":"Request object containing kits to be removed from shipment."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Kits to be removed from the shipment.

Show Source

• Array of: string(uuid)

{
    "minItems":1,
    "type":"array",
    "description":"Kits to be removed from the shipment.",
    "example":[
        "E39FF55A445543A38D513325664F0B2D"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "E39FF55A445543A38D513325664F0B2D"
]

Nested Schema : nsKits

Type: array

Kits to be removed from the shipment.

Show Source

• Array of: object ShipmentRemoveNonSerializedKitRequest
  Request object containing non serialized kits to be removed from shipment.

{
    "type":"array",
    "description":"Kits to be removed from the shipment.",
    "example":[
        {
            "lotId":"C36A3197FDEE433FB5547EE83DE99E4B",
            "kitTypeSrcId":"D313327EF13845169A8ADADDA435431E",
            "quantity":56
        }
    ],
    "items":{
        "$ref":"#/components/schemas/ShipmentRemoveNonSerializedKitRequest"
    }
}

Example:

[
    {
        "lotId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "kitTypeSrcId":"D313327EF13845169A8ADADDA435431E",
        "quantity":56
    }
]

Nested Schema : ShipmentRemoveNonSerializedKitRequest

Type: object

Request object containing non serialized kits to be removed from shipment.

Show Source

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

  Quantity of kits

  Example: 56

{
    "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":{
            "minimum":1,
            "type":"number",
            "description":"Quantity of kits",
            "format":"BigDecimal",
            "example":56
        }
    },
    "description":"Request object containing non serialized kits to be removed from shipment.",
    "example":{
        "lotId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "kitTypeSrcId":"D313327EF13845169A8ADADDA435431E",
        "quantity":56
    }
}

Example:

{
    "lotId":"C36A3197FDEE433FB5547EE83DE99E4B",
    "kitTypeSrcId":"D313327EF13845169A8ADADDA435431E",
    "quantity":56
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

Examples

Select an example Remove Kits Response

400 Response

'Invalid Kit', 'Invalid shipment status'

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Bad Request

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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Not Found

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Server Error

Back to Top