Jump to

• Request
• Response

v1.0

post

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

Updates shipment as received for destruction. Rights: OrsInventoryPost and either OrsBlinded or 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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request object containing shipment received for destruction details.

Show Source

• confirmReceiptPerKit(required): boolean
  Indicates whether receipt confirmation is per kit.

  Example: true
• partialUpdate: boolean
  Indicates whether kits are updated partially.

  Example: true
• receivedKits: array receivedKits

{
    "required":[
        "confirmReceiptPerKit"
    ],
    "type":"object",
    "properties":{
        "receivedKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReconShipmentKitTO"
            }
        },
        "partialUpdate":{
            "type":"boolean",
            "description":"Indicates whether kits are updated partially.",
            "example":true
        },
        "confirmReceiptPerKit":{
            "type":"boolean",
            "description":"Indicates whether receipt confirmation is per kit.",
            "example":true
        }
    },
    "description":"Request object containing shipment received for destruction details."
}

Nested Schema : receivedKits

Type: array

Show Source

• Array of: object ReconShipmentKitTO
  Title: ReconShipmentKitTO

  Request payload to update reconciliation shipment kit details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReconShipmentKitTO"
    }
}

Nested Schema : ReconShipmentKitTO

Type: object

Title: ReconShipmentKitTO

Request payload to update reconciliation shipment kit details.

Show Source

• depotReturnedUnits(required): number (double)
  Title: Depot Returned Units

  Minimum Value: 0

  Units returned to depot.

  Example: 5
• id(required): string (uuid)
  Title: Inventory ID

  Inventory ID

  Example: 00000000-0000-0000-0000-000000000001

{
    "title":"ReconShipmentKitTO",
    "required":[
        "depotReturnedUnits",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID",
            "format":"uuid",
            "example":"00000000-0000-0000-0000-000000000001"
        },
        "depotReturnedUnits":{
            "title":"Depot Returned Units",
            "minimum":0,
            "type":"number",
            "description":"Units returned to depot.",
            "format":"double",
            "example":5
        }
    },
    "description":"Request payload to update reconciliation shipment kit details."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

400 Response

Invalid kit OR Invalid order status.

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

403 Response

User doesn't have access to the depot.

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

404 Response

Study not found OR 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

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

Back to Top