Jump to

• Request
• Response

v4.0

put

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

Updates the status of a kit at a site. Returns formInstanceId when user updates kits to pendingDestruction.
Rights: OrsInventoryPost and either OrsUnblinded or OrsBlinded.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• instanceNumber: number (BigDecimal)
  InstanceNumber

  Example: 1
• inventoryStatusId(required): integer (int32)
  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).

  Example: 10
• kits: array kits
  Title: kits

  Contains kit IDs.
• kitsFilter: object SiteUserUpdateKitsFilter
  Contains filter criteria to update kits.
• missingUnits: number (BigDecimal)
  Missing Units of Kit.

  Example: 0
• reason: string
  Reason description.

  Example: Reconciled at site
• returnedUnits: number (BigDecimal)
  Returned Units of Kit.

  Example: 2
• 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.
• visitSrcId: string (uuid)
  Visit source ID

{
    "required":[
        "inventoryStatusId"
    ],
    "type":"object",
    "properties":{
        "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,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "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"
        },
        "reason":{
            "type":"string",
            "description":"Reason description.",
            "example":"Reconciled at site"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned Units of Kit.",
            "format":"BigDecimal",
            "example":2
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing Units of Kit.",
            "format":"BigDecimal",
            "example":0
        },
        "visitSrcId":{
            "type":"string",
            "description":"Visit source ID",
            "format":"uuid"
        },
        "instanceNumber":{
            "type":"number",
            "description":"InstanceNumber",
            "format":"BigDecimal",
            "example":1
        },
        "kits":{
            "title":"kits",
            "type":"array",
            "description":"Contains kit IDs.",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF",
                "C36A3197FDEE433FB5547EE83DE99E4B"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/SiteUserUpdateKitsFilter"
        }
    }
}

Nested Schema : kits

Type: array

Title: kits

Contains kit IDs.

Show Source

• Array of: string(uuid)

{
    "title":"kits",
    "type":"array",
    "description":"Contains kit IDs.",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF",
        "C36A3197FDEE433FB5547EE83DE99E4B"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF",
    "C36A3197FDEE433FB5547EE83DE99E4B"
]

Nested Schema : SiteUserUpdateKitsFilter

Type: object

Contains filter criteria to update kits.

Show Source

• inventoryStatusIds: array inventoryStatusIds
  Title: inventoryStatusIds

  List of inventory status IDs.
• kitRange: string
  Range of the kit.

  Example: KIT_NUMBER:10:100
• searchString: string
  Search string.

  Example: KIT
• serialized: boolean
  Is kit serialized or non-serialized

  Example: true

{
    "type":"object",
    "properties":{
        "serialized":{
            "type":"boolean",
            "description":"Is kit serialized or non-serialized",
            "example":true
        },
        "kitRange":{
            "type":"string",
            "description":"Range of the kit.",
            "example":"KIT_NUMBER:10:100"
        },
        "searchString":{
            "type":"string",
            "description":"Search string.",
            "example":"KIT"
        },
        "inventoryStatusIds":{
            "title":"inventoryStatusIds",
            "type":"array",
            "description":"List of inventory status IDs.",
            "example":[
                5,
                10
            ],
            "items":{
                "type":"integer",
                "format":"int32"
            }
        }
    },
    "description":"Contains filter criteria to update kits.",
    "example":{
        "kitRange":"KIT_NUMBER:10:100",
        "searchString":"KIT",
        "inventoryStatusIds":[
            5,
            10
        ],
        "serialized":true
    }
}

Example:

{
    "kitRange":"KIT_NUMBER:10:100",
    "searchString":"KIT",
    "inventoryStatusIds":[
        5,
        10
    ],
    "serialized":true
}

Nested Schema : inventoryStatusIds

Type: array

Title: inventoryStatusIds

List of inventory status IDs.

Show Source

• Array of: integer(int32)

{
    "title":"inventoryStatusIds",
    "type":"array",
    "description":"List of inventory status IDs.",
    "example":[
        5,
        10
    ],
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Example:

[
    5,
    10
]

Examples

Select an example Update Kits Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : UpdateSiteKitResponse

Type: object

Title: UpdateSiteKitResponse

Response object of update kit at site.

Show Source

• formInstanceId: string (uuid)
  Title: Form Instance ID

  Form instance identifier of non-subject forms.
• id: string (uuid)
  Title: ID

  ID
• tempExcursionNumber: string
  Title: Temperature Excursion Number

  Temperature excursion number.

  Example: 001

{
    "title":"UpdateSiteKitResponse",
    "type":"object",
    "properties":{
        "id":{
            "title":"ID",
            "type":"string",
            "description":"ID",
            "format":"uuid"
        },
        "tempExcursionNumber":{
            "title":"Temperature Excursion Number",
            "type":"string",
            "description":"Temperature excursion number.",
            "example":"001"
        },
        "formInstanceId":{
            "title":"Form Instance ID",
            "type":"string",
            "description":"Form instance identifier of non-subject forms.",
            "format":"uuid"
        }
    },
    "description":"Response object of update kit at site."
}

Examples

Select an example Update Kits Response

400 Response

For invalid subject or inventory status or invalid transition status for, kit does not belong to site.

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 Update Kits Bad Request Response

404 Response

For invalid study ID or study still in design phase AND for invalid kit and study combination.

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 Update Kits 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 Update Kits Server Error Response

Back to Top