Jump to

• Request
• Response

Update a kit's barcode by kit ID

put

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

Updates a kit's barcode by kit ID. Rights: OrsInventoryPost and OrsUnblinded.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : KitBarcodeTO v1.0

Type: object

Title: KitBarcodeTO v1.0

object containing Kit's barcode

Show Source

• barcode: string
  Minimum Length: 0

  Maximum Length: 1000

  barcode of the kit

  Example: 61234

{
    "title":"KitBarcodeTO v1.0",
    "type":"object",
    "properties":{
        "barcode":{
            "maxLength":"1000",
            "minLength":"0",
            "type":"string",
            "description":"barcode of the kit",
            "example":"61234"
        }
    },
    "description":"object containing Kit's barcode"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : KitBarcodeTO v1.0

Type: object

Title: KitBarcodeTO v1.0

object containing Kit's barcode

Show Source

• barcode: string
  Minimum Length: 0

  Maximum Length: 1000

  barcode of the kit

  Example: 61234

{
    "title":"KitBarcodeTO v1.0",
    "type":"object",
    "properties":{
        "barcode":{
            "maxLength":"1000",
            "minLength":"0",
            "type":"string",
            "description":"barcode of the kit",
            "example":"61234"
        }
    },
    "description":"object containing Kit's barcode"
}

400 Response

Invalid Inventory Status

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 version OR Study not found OR Inventory 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