Jump to

• Request
• Response

v1.0

put

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

Request

Path Parameters

• kitId(required): string(uuid)
• mode(required): string
  Mode of the study, accepts: test, active, or training.
• siteId(required): string(uuid)
• 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 : SiteUserUpdateKitStatusRequestV1

Type: object

Title: SiteUserUpdateKitStatusRequestV1

Contains site update kit status request.

Show Source

• 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
• reason: string
  Reason for update

  Example: Some description
• subjectId: string (uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

{
    "title":"SiteUserUpdateKitStatusRequestV1",
    "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 subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason for update",
            "example":"Some description"
        }
    },
    "description":"Contains site update kit status request."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

default response

Back to Top