Jump to

• Request
• Response

v2.0

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadkits

Retrieves inventory headers containing barcodes from the database.

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• */*

200 Response

Successful operation

Body ()

Root Schema : UploadDBHeaderResponse

Type: object

Title: UploadDBHeaderResponse

Contains database header response.

Show Source

• dbHeaders: array DB Headers
  Title: DB Headers

  Database headers.

{
    "title":"UploadDBHeaderResponse",
    "type":"object",
    "properties":{
        "dbHeaders":{
            "title":"DB Headers",
            "type":"array",
            "description":"Database headers.",
            "example":[
                "Kit Type",
                "Kit Number"
            ],
            "items":{
                "type":"string",
                "example":"Kit Number"
            }
        }
    },
    "description":"Contains database header response."
}

Nested Schema : DB Headers

Type: array

Title: DB Headers

Database headers.

Show Source

• Array of: string
  Example: Kit Number

{
    "title":"DB Headers",
    "type":"array",
    "description":"Database headers.",
    "example":[
        "Kit Type",
        "Kit Number"
    ],
    "items":{
        "type":"string",
        "example":"Kit Number"
    }
}

Example:

[
    "Kit Type",
    "Kit Number"
]

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