Jump to

• Request
• Response

v1.0

post

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

Updates a quarantine shipment and its kits. Rights: DepotQuarantinePost.

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

Show Source

• damagedKits: array Damaged Kits
  Title: Damaged Kits

  UUIDs of kits to update as damaged.
• updateNSKits: array Non-Serialized Kits
  Title: Non-Serialized Kits

  List of non-serialized kits to update.

{
    "type":"object",
    "properties":{
        "damagedKits":{
            "title":"Damaged Kits",
            "type":"array",
            "description":"UUIDs of kits to update as damaged.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "updateNSKits":{
            "title":"Non-Serialized Kits",
            "type":"array",
            "description":"List of non-serialized kits to update.",
            "items":{
                "$ref":"#/components/schemas/NSKitsRequest"
            }
        }
    }
}

Nested Schema : Damaged Kits

Type: array

Title: Damaged Kits

UUIDs of kits to update as damaged.

Show Source

• Array of: string(uuid)

{
    "title":"Damaged Kits",
    "type":"array",
    "description":"UUIDs of kits to update as damaged.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : Non-Serialized Kits

Type: array

Title: Non-Serialized Kits

List of non-serialized kits to update.

Show Source

• Array of: object NSKitsRequest v1.0
  Title: NSKitsRequest v1.0

  Request containing non-serialized kits details.

{
    "title":"Non-Serialized Kits",
    "type":"array",
    "description":"List of non-serialized kits to update.",
    "items":{
        "$ref":"#/components/schemas/NSKitsRequest"
    }
}

Nested Schema : NSKitsRequest v1.0

Type: object

Title: NSKitsRequest v1.0

Request containing non-serialized kits details.

Show Source

• inventoryStatusId: integer (int32)
  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 10
• kitTypeId: string (uuid)
  Title: Kit Type ID

  Kit type identifier.
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.
• quantity(required): number (BigDecimal)
  Title: Quantity

  Minimum Value: 1

  Kit quantity.

{
    "title":"NSKitsRequest v1.0",
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "inventoryStatusId":{
            "type":"integer",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"int32",
            "example":10
        },
        "quantity":{
            "title":"Quantity",
            "minimum":1,
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal"
        }
    },
    "description":"Request containing non-serialized kits details."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : QuarantinedToReceivedResponse v1.0

Type: object

Title: QuarantinedToReceivedResponse v1.0

Contains counts of kits updated from quarantine to received.

Show Source

• availableCount: integer (int64)
  Title: Available Count

  Count of kits marked as available in the shipment.
• damagedCount: integer (int64)
  Title: Damaged Count

  Count of kits marked as damaged in the shipment.
• receivedDate: string (date-time)
  Title: Received Date

  Received date of the shipment.

{
    "title":"QuarantinedToReceivedResponse v1.0",
    "type":"object",
    "properties":{
        "receivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Received date of the shipment.",
            "format":"date-time"
        },
        "availableCount":{
            "title":"Available Count",
            "type":"integer",
            "description":"Count of kits marked as available in the shipment.",
            "format":"int64"
        },
        "damagedCount":{
            "title":"Damaged Count",
            "type":"integer",
            "description":"Count of kits marked as damaged in the shipment.",
            "format":"int64"
        }
    },
    "description":"Contains counts of kits updated from quarantine to received."
}

400 Response

'Invalid Kit', 'Invalid shipment 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

404 Response

'Invalid study ID', 'Study still in design phase' or 'Invalid shipment 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