Jump to

• Request
• Response

Remove both serialized and non serialized kits from an order shipment

post

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

Removes both serialized and non serialized kits from an order shipment. Rights: OrsInventoryDelete, 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)
  ID of the study

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

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

Show Source

• kits: array kits
  Contains kits Ids.
• nsKits: array nsKits
  Contains kits Ids.
• shipmentId: string (uuid)
  ID of the shipment.

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "kits":{
            "type":"array",
            "description":"Contains kits Ids.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "nsKits":{
            "type":"array",
            "description":"Contains kits Ids.",
            "items":{
                "$ref":"#/components/schemas/ShipmentRemoveNonSerializedKitRequest"
            }
        }
    },
    "description":"Request object containing serialized and non serialized kits to be removed from shipment."
}

Nested Schema : kits

Type: array

Contains kits Ids.

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "description":"Contains kits Ids.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : nsKits

Type: array

Contains kits Ids.

Show Source

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

{
    "type":"array",
    "description":"Contains kits Ids.",
    "items":{
        "$ref":"#/components/schemas/ShipmentRemoveNonSerializedKitRequest"
    }
}

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)
  Lot ID
• quantity(required): number (BigDecimal)
  Minimum Value: 1

  Quantity of kits

  Example: 56

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "lotId":{
            "type":"string",
            "description":"Lot ID",
            "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."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

400 Response

'Invalid Kit', 'Invalid shipment status'

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

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