Get kit details by order

get

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

Retrieves a kit's details by order. Rights: OrsInventoryGet, OrsUnblinded.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ShipmentKitsResponse v1.0
Type: object
Title: ShipmentKitsResponse v1.0
Response object containing shipment kits details.
Show Source
Nested Schema : kitTypes
Type: array
Show Source
Nested Schema : ShipmentKitsResponse.KitTypeSummary v1.0
Type: object
Title: ShipmentKitsResponse.KitTypeSummary v1.0
Kit type summary details object.
Show Source
Nested Schema : kits
Type: array
Show Source
Nested Schema : ShipmentKitsResponse.Kit v1.0
Type: object
Title: ShipmentKitsResponse.Kit v1.0
Kit details object.
Show Source

404 Response

'Invalid study ID', 'Study still in design phase' or 'Invalid shipment ID'
Body ()
Root Schema : DesignerResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.

500 Response

Internal server error
Body ()
Root Schema : DesignerResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top