Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory/lots/{lotId}

Adds quantity for non-serialized kit types to lots.

Request

Path Parameters

• lotId(required): string(uuid)
  Lot ID
• mode(required): string
  Mode of the study, accepts: test, active, or training.
• 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 : NSAddQuantityToLotRequest v1.0

Type: object

Title: NSAddQuantityToLotRequest v1.0

Request to add non-serialized kit type quantities to lot.

Show Source

• receivedKits(required): array receivedKits
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

{
    "title":"NSAddQuantityToLotRequest v1.0",
    "required":[
        "receivedKits"
    ],
    "type":"object",
    "properties":{
        "receivedKits":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NSKitTypeQuantityToLotV1"
            }
        }
    },
    "description":"Request to add non-serialized kit type quantities to lot."
}

Nested Schema : receivedKits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

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

  KitType quantity object.

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NSKitTypeQuantityToLotV1"
    }
}

Nested Schema : NSKitTypeQuantityToLot v1.0

Type: object

Title: NSKitTypeQuantityToLot v1.0

KitType quantity object.

Show Source

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

  Kit type identifier.
• quantity: number (BigDecimal)
  Title: Quantity

  Minimum Value: 1

  Maximum Value: 999999999

  Kit quantity.

  Example: 10

{
    "title":"NSKitTypeQuantityToLot v1.0",
    "type":"object",
    "properties":{
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "quantity":{
            "title":"Quantity",
            "maximum":999999999,
            "minimum":1,
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":10
        }
    },
    "description":"KitType quantity object."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : InventoryStatus

Type: object

Inventory status

Show Source

• inventoryStatus: string
  Allowed Values: [ "Available", " Damaged", " Destroyed", " Dispensed", " Expired", " Not in Use", " Misallocated", " Missing", " In Transit", " Quarantined", " Pre-quarantined", " Pending Destruction", " Lost by Subject", " Temporarily Unavailable", " Damaged by Subject", " New", " Not Dispensed to Subject", " Returned to Site", " Conserved", "Received for Destruction" ]

  Inventory status

  Example: New, Damaged
• inventoryStatusId: integer (int64)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

  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).

{
    "type":"object",
    "properties":{
        "inventoryStatus":{
            "type":"string",
            "description":"Inventory status",
            "example":"New, Damaged",
            "enum":[
                "Available",
                " Damaged",
                " Destroyed",
                " Dispensed",
                " Expired",
                " Not in Use",
                " Misallocated",
                " Missing",
                " In Transit",
                " Quarantined",
                " Pre-quarantined",
                " Pending Destruction",
                " Lost by Subject",
                " Temporarily Unavailable",
                " Damaged by Subject",
                " New",
                " Not Dispensed to Subject",
                " Returned to Site",
                " Conserved",
                "Received for Destruction"
            ]
        },
        "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":"int64",
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        }
    },
    "description":"Inventory status"
}

400 Response

Invalid Non-serialized kit type or duplicate kit type in request or Invalid Lot 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

404 Response

Invalid study ID or version

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