Jump to

• Request
• Response

Kitlist details of each kit

post

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

Kitlist details of each kit. In this API, blockNumber and kitNumberUTF are added to return Block Number and kit Number in UTF8. Rights: OrsInventoryGet.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study

Query Parameters

• inventorySourceId: string
• limit(required): integer(int32)
  Minimum Value: 1
• offset(required): integer(int32)
  Minimum Value: 0
• transactionId: string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : KitDetailsExtTO

Type: object

Title: KitDetailsExtTO

Contains kitId of each Kit or no Kits

Show Source

• kits: array kits
  Minimum Number of Items: 0

  Maximum Number of Items: 2147483647

  kits

{
    "title":"KitDetailsExtTO",
    "type":"object",
    "properties":{
        "kits":{
            "maxItems":"2147483647",
            "minItems":"0",
            "type":"array",
            "description":"kits",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains kitId of each Kit or no Kits"
}

Nested Schema : kits

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

kits

Show Source

• Array of: string(uuid)

{
    "maxItems":"2147483647",
    "minItems":"0",
    "type":"array",
    "description":"kits",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Successful operation

Body ()

Root Schema : KitsAuditResponse v3.0

Type: object

Title: KitsAuditResponse v3.0

Response object containing KitList Details of each kit.

Show Source

• barCode: string
  Bar Code
• blockNumber: string
  Block Number
• comment: string
  Comment
• deviceId: string
  deviceID
• donotCount: number (BigDecimal)
  Donot Count
• donotShip: number (BigDecimal)
  Donot Ship
• expirationDate: string (date-time)
  Expiration Date
• instanceNumber: number (BigDecimal)
  Instance number of the unscheduled visit

  Example: 2
• inventoryId: string (uuid)
  Unique id for inventory
• inventorySourceId: string (uuid)
  Inventory Source ID
• inventorySourceVersionStart: string (date-time)
  Inventory Source Version Start
• inventoryStatusId: number (BigDecimal)
  Inventory StatusId
• itemNumber: string
  Item Number
• kitNumber: number (BigDecimal)
  Kit Number
• kitNumberUTF: string
  Kit Number UTF
• kitTypeId: string (uuid)
  Kittype id for each Kit
• kitTypeVersionStart: string (date-time)
  Kittype Version Start
• labelGroupId: string (uuid)
  Label GroupId
• labelGroupVersionStart: string (date-time)
  Lot Group Version Start
• lotId: string (uuid)
  Lot Id for each Lot
• lotVersionStart: string (date-time)
  Lot Version Start
• materialId: string
  Material Id
• missingUnits: number (BigDecimal)
  Missing Units
• objectVersionNumber: number (BigDecimal)
  Object Version Number
• operationType: string
  operation Type
• reason: string
  Reason
• returnedUnits: boolean (BigDecimal)
  Returned Units
• sequenceNumber: number (BigDecimal)
  Sequence Number
• siteId: string (uuid)
  Site id for each Site
• siteVersionStart: string (date-time)
  Site Version Start
• softwareVersionNumber: number (BigDecimal)
  Software Version Number
• studyId: string (uuid)
  Study ID
• studyVersionStart: string (date-time)
  Study Version Start
• subjectId: string (uuid)
  ID of the subject
• transactionId: string (uuid)
  transactionID
• userId: string (uuid)
  User id for each User
• verified: number (BigDecimal)
  Verified
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start
• visitId: string (uuid)
  ID of the visit

{
    "title":"KitsAuditResponse v3.0",
    "type":"object",
    "properties":{
        "inventoryId":{
            "type":"string",
            "description":"Unique id for inventory",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "operationType":{
            "type":"string",
            "description":"operation Type"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object Version Number",
            "format":"BigDecimal"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software Version Number",
            "format":"BigDecimal"
        },
        "userId":{
            "type":"string",
            "description":"User id for each User",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason"
        },
        "comment":{
            "type":"string",
            "description":"Comment"
        },
        "siteId":{
            "type":"string",
            "description":"Site id for each Site",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site Version Start",
            "format":"date-time"
        },
        "kitTypeId":{
            "type":"string",
            "description":"Kittype id for each Kit",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kittype Version Start",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id for each Lot",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot Version Start",
            "format":"date-time"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence Number",
            "format":"BigDecimal"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory StatusId",
            "format":"BigDecimal"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label GroupId",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Lot Group Version Start",
            "format":"date-time"
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration Date",
            "format":"date-time"
        },
        "donotCount":{
            "type":"number",
            "description":"Donot Count",
            "format":"BigDecimal"
        },
        "donotShip":{
            "type":"number",
            "description":"Donot Ship",
            "format":"BigDecimal"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit Number",
            "format":"BigDecimal"
        },
        "studyId":{
            "type":"string",
            "description":"Study ID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study Version Start",
            "format":"date-time"
        },
        "inventorySourceId":{
            "type":"string",
            "description":"Inventory Source ID",
            "format":"uuid"
        },
        "inventorySourceVersionStart":{
            "type":"string",
            "description":"Inventory Source Version Start",
            "format":"date-time"
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing Units",
            "format":"BigDecimal"
        },
        "returnedUnits":{
            "type":"boolean",
            "description":"Returned Units",
            "format":"BigDecimal"
        },
        "verified":{
            "type":"number",
            "description":"Verified",
            "format":"BigDecimal"
        },
        "deviceId":{
            "type":"string",
            "description":"deviceID"
        },
        "barCode":{
            "type":"string",
            "description":"Bar Code"
        },
        "materialId":{
            "type":"string",
            "description":"Material Id"
        },
        "itemNumber":{
            "type":"string",
            "description":"Item Number"
        },
        "transactionId":{
            "type":"string",
            "description":"transactionID",
            "format":"uuid"
        },
        "blockNumber":{
            "type":"string",
            "description":"Block Number"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit Number UTF"
        },
        "subjectId":{
            "type":"string",
            "description":"ID  of the subject",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "instanceNumber":{
            "type":"number",
            "description":"Instance number of the unscheduled visit",
            "format":"BigDecimal",
            "example":"2"
        }
    },
    "description":"Response object containing KitList Details of 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