Jump to

• Request
• Response

Mark kits as received

post

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

Marks kits as received in a study's inventory. Rights: OrsInventoryPost and 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)
  ID of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• tempMonitorStatus: string
  Allowed Values: [ "yes", "no", "missing" ]

  Pattern: yes|no|missing

  Temprature Montior Status

  Example: yes
• updateKits: object updateKits
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "updateKits":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "tempMonitorStatus":{
            "pattern":"yes|no|missing",
            "type":"string",
            "description":"Temprature Montior Status",
            "example":"yes",
            "enum":[
                "yes",
                "no",
                "missing"
            ]
        }
    }
}

Nested Schema : updateKits

Type: object

Additional Properties Allowed

Show Source

• integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentReceivedResponse

Type: object

Received shipment details response object.

Show Source

• availableCount: integer (int64)
  Available kits count.

  Example: 5
• damagedCount: integer (int64)
  Damaged kits count.

  Example: 5
• missingCount: integer (int64)
  Missing kits count.

  Example: 5
• preQuarantinedCount: integer (int64)
  Pre quarantined kits count.

  Example: 5
• receivedDate: string (date-time)
  Shipment received date.
• shipmentId: string (uuid)
  ID of the shipment.

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "receivedDate":{
            "type":"string",
            "description":"Shipment received date.",
            "format":"date-time"
        },
        "damagedCount":{
            "type":"integer",
            "description":"Damaged kits count.",
            "format":"int64",
            "example":"5"
        },
        "missingCount":{
            "type":"integer",
            "description":"Missing kits count.",
            "format":"int64",
            "example":"5"
        },
        "preQuarantinedCount":{
            "type":"integer",
            "description":"Pre quarantined kits count.",
            "format":"int64",
            "example":"5"
        },
        "availableCount":{
            "type":"integer",
            "description":"Available kits count.",
            "format":"int64",
            "example":"5"
        }
    },
    "description":"Received shipment details response object."
}

400 Response

'Invalid order status', 'Invalid kit'

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

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID', 'Invalid site ID'

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