Jump to

• Request
• Response

v4.0

post

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kits/audit

Kit list details of each kit. In this API, tempExcursionNumber is added to return Temperature Excursion Number. Rights: OrsInventoryGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Query Parameters

• inventorySourceId: string
  Source ID of the inventory.

  Example:

  9B83BFB48C5A41C59775E4D8D22D8B26

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

  Maximum number of records to display per page.

  Example:

  100

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

  Example:

  0

• transactionId: string
  String value for transaction ID of shipment.

  Example:

  AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

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"
    }
}

Examples

Select an example Kits Audit Request

Back to Top

Response

Supported Media Types

• application/json

202 Response

Successful operation

Body ()

Root Schema : Kits Audit Response v4.0

Type: object

Title: Kits Audit Response v4.0

Response containing audit details for each kit.

Show Source

• barCode: string
  Barcode.
• blockNumber: string
  Title: Block Number

  Block number.
• comment: string
  Comment.
• depotReturnedUnits: number
  Number of units returned to depot.
• deviceId: string
  deviceID
• dispensationConfirmed: boolean
  Indicates whether dispensation is confirmed.
• doNotCount: number
  Title: Do Not Count

  Do Not Count (DNC) days.
• doNotShip: number
  Title: Do Not Ship

  Do Not Ship (DNS) days.
• expirationDate: string (date-time)
  Expiration date.
• instanceNumber: number (BigDecimal)
  Instance number of the unscheduled visit

  Example: 2
• inventoryId: string (uuid)
  Inventory ID.
• inventorySourceId: string (uuid)
  Inventory ID.
• inventorySourceVersionStart: string (date-time)
  Inventory version start.
• 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
• itemNumber: string
  Title: Item Number

  Item number.
• kitNumber: number
  Title: Kit Number

  Kit number.
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.
• 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.
• materialId: string
  Title: Material ID

  Material ID.
• missingUnits: number
  Missing units for the kit.
• objectVersionNumber: number
  Object version number.
• operationType: string
  Operation type.
• reason: string
  Reason.
• returnedUnits: number
  Returned units for the kit.
• sequenceNumber: number
  Sequence number.
• siteId: string (uuid)
  Site ID.
• siteVersionStart: string (date-time)
  Site version start date.
• softwareVersionNumber: number
  Software version number.
• studyId: string (uuid)
  Study ID
• studyVersionStart: string (date-time)
  Study Version Start
• subjectId: string (uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.
• tempExcursionNumber: string
  Temperature excursion number.

  Example: 001
• transactionId: string (uuid)
  Audit transaction ID.
• userId: string (uuid)
  User ID.
• verified: boolean
  Verified
• versionEnd: string (date-time)
  Version end date.
• versionStart: string (date-time)
  Version start date.
• visitId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

{
    "title":"Kits Audit Response v4.0",
    "type":"object",
    "properties":{
        "inventoryId":{
            "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."
        },
        "siteId":{
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "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"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number."
        },
        "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"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time"
        },
        "doNotCount":{
            "title":"Do Not Count",
            "type":"number",
            "description":"Do Not Count (DNC) days."
        },
        "doNotShip":{
            "title":"Do Not Ship",
            "type":"number",
            "description":"Do Not Ship (DNS) days."
        },
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit number."
        },
        "studyId":{
            "type":"string",
            "description":"Study ID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study Version Start",
            "format":"date-time"
        },
        "inventorySourceId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "inventorySourceVersionStart":{
            "type":"string",
            "description":"Inventory version start.",
            "format":"date-time"
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing units for the kit."
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned units for the kit."
        },
        "verified":{
            "type":"boolean",
            "description":"Verified"
        },
        "deviceId":{
            "type":"string",
            "description":"deviceID"
        },
        "barCode":{
            "type":"string",
            "description":"Barcode."
        },
        "dispensationConfirmed":{
            "type":"boolean",
            "description":"Indicates whether dispensation is confirmed."
        },
        "depotReturnedUnits":{
            "type":"number",
            "description":"Number of units returned to depot."
        },
        "materialId":{
            "title":"Material ID",
            "type":"string",
            "description":"Material ID."
        },
        "itemNumber":{
            "title":"Item Number",
            "type":"string",
            "description":"Item number."
        },
        "transactionId":{
            "type":"string",
            "description":"Audit transaction ID.",
            "format":"uuid"
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"string",
            "description":"Block number."
        },
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support."
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "instanceNumber":{
            "type":"number",
            "description":"Instance number of the unscheduled visit",
            "format":"BigDecimal",
            "example":2
        },
        "tempExcursionNumber":{
            "type":"string",
            "description":"Temperature excursion number.",
            "example":"001"
        }
    },
    "description":"Response containing audit details for each kit."
}

Examples

Select an example Kits Audit Response

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

Examples

Select an example Kits Audit Bad Request Response

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

Examples

Select an example Kits Audit Not Found Response

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

Examples

Select an example Kits Audit Server Error Response

Back to Top