Jump to

• Request
• Response

v2.0

post

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

Updates the shipment and its kits as quarantined. Rights: OrsInventoryPost, DepotShipmentReceiptPost/OrsBlinded.

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

• */*

Request Body - */* ()

Root Schema : ShipmentQuarantineRequest v1.0

Type: object

Title: ShipmentQuarantineRequest v1.0

Request body to quarantine a shipment.

Show Source

• tempMonitorStatus(required): string
  Title: Temperature Monitor Status

  Allowed Values: [ "yes", "no", "missing" ]

  Temperature monitor status. Allowed values: yes, no, missing.

  Example: missing

{
    "title":"ShipmentQuarantineRequest v1.0",
    "required":[
        "tempMonitorStatus"
    ],
    "type":"object",
    "properties":{
        "tempMonitorStatus":{
            "title":"Temperature Monitor Status",
            "type":"string",
            "description":"Temperature monitor status. Allowed values: yes, no, missing.",
            "example":"missing",
            "enum":[
                "yes",
                "no",
                "missing"
            ]
        }
    },
    "description":"Request body to quarantine a 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