Jump to

• Request
• Response

v1.0

post

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

Retrieves audit information of each kit from non-serialized inventory.
Rights: OrsInventoryGet.

Request

Path Parameters

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

Query Parameters

• limit(required): integer(int32)
  Minimum Value: 1

  Maximum number of records to display per page.
• offset(required): integer(int32)
  Minimum Value: 0

  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.
• transactionId: string
  String value for transaction ID of shipment.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Kits Audit Request

Type: object

Title: Kits Audit Request

Request object containing kit IDs.

Show Source

• kits: array Kits
  Title: Kits

  Minimum Number of Items: 0

  Maximum Number of Items: 2147483647

  List of kit IDs.

{
    "title":"Kits Audit Request",
    "type":"object",
    "properties":{
        "kits":{
            "title":"Kits",
            "maxItems":2147483647,
            "minItems":0,
            "type":"array",
            "description":"List of kit IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Request object containing kit IDs."
}

Nested Schema : Kits

Type: array

Title: Kits

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

List of kit IDs.

Show Source

• Array of: string(uuid)

{
    "title":"Kits",
    "maxItems":2147483647,
    "minItems":0,
    "type":"array",
    "description":"List of kit IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Successful operation

Body ()

Root Schema : NSKitsAuditResponse v1.0

Type: object

Title: NSKitsAuditResponse v1.0

Response containing audit details for each kit.

Show Source

• comment: string
  Comment.
• inventoryStatusId: number
  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)
  Kit type ID.
• kitTypeVersionStart: string (date-time)
  Kit type version start date.
• labelGroupId: string (uuid)
  Label group ID.
• labelGroupVersionStart: string (date-time)
  Label group version start date.
• lotId: string (uuid)
  Lot ID.
• lotVersionStart: string (date-time)
  Lot version start date.
• nsInventoryId: string (uuid)
  Inventory ID.
• objectVersionNumber: number
  Object version number.
• operationType: string
  Operation type.
• quantity: number
  Kit quantity.

  Example: 2
• reason: string
  Reason.
• restrictedQuantity: number
  Restricted quantity.

  Example: 2
• sdfId: string (uuid)
  Source identifier.
• softwareVersionNumber: number
  Software version number.
• transactionId: string (uuid)
  Audit transaction ID.
• userId: string (uuid)
  User ID.
• versionEnd: string (date-time)
  Version end date.
• versionStart: string (date-time)
  Version start date.

{
    "title":"NSKitsAuditResponse v1.0",
    "type":"object",
    "properties":{
        "nsInventoryId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type."
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number."
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number."
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason."
        },
        "comment":{
            "type":"string",
            "description":"Comment."
        },
        "kitTypeId":{
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kit type version start date.",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot version start date.",
            "format":"date-time"
        },
        "inventoryStatusId":{
            "type":"number",
            "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).",
            "example":10
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Label group version start date.",
            "format":"date-time"
        },
        "transactionId":{
            "type":"string",
            "description":"Audit transaction ID.",
            "format":"uuid"
        },
        "sdfId":{
            "type":"string",
            "description":"Source identifier.",
            "format":"uuid"
        },
        "quantity":{
            "type":"number",
            "description":"Kit quantity.",
            "example":2
        },
        "restrictedQuantity":{
            "type":"number",
            "description":"Restricted quantity.",
            "example":2
        }
    },
    "description":"Response containing audit details for each kit."
}

400 Response

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 OR Study not found OR Inventory Source ID not found.

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