Jump to

• Request
• Response

v1.0

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/label-group

Updates kit label group. Rights: OrsInventoryPost and OrsUnblinded.

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request object for kit label.

Show Source

• kitFilters: object KitFiltersRequest v1.0
  Title: KitFiltersRequest v1.0

  Request object for kit filters.
• kits: array Kits
  Title: Kits

  List of kit IDs.
• labelGroupId: string (uuid)
  ID of the label group.
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason.

  Example: kit damaged by subject

{
    "type":"object",
    "properties":{
        "kitFilters":{
            "$ref":"#/components/schemas/KitFiltersRequestV1"
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"List of kit IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason.",
            "example":"kit damaged by subject"
        },
        "labelGroupId":{
            "type":"string",
            "description":"ID of the label group.",
            "format":"uuid"
        }
    },
    "description":"Request object for kit label."
}

Nested Schema : KitFiltersRequest v1.0

Type: object

Title: KitFiltersRequest v1.0

Request object for kit filters.

Show Source

• kitRange: string
  Kit range.

  Example: SEQUENCE_NUMBER:900:1200
• kitStatus: string
  Kit status ID.

  Example: 1
• kitTypeId: string (uuid)
  Title: Kit Type ID

  Kit type identifier.
• labelGroupId: string
  Label group ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• location: string
  Location.

  Example: ALL_SITES
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.

{
    "title":"KitFiltersRequest v1.0",
    "type":"object",
    "properties":{
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "location":{
            "type":"string",
            "description":"Location.",
            "example":"ALL_SITES"
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "kitStatus":{
            "type":"string",
            "description":"Kit status ID.",
            "example":"1"
        },
        "kitRange":{
            "type":"string",
            "description":"Kit range.",
            "example":"SEQUENCE_NUMBER:900:1200"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Request object for kit filters."
}

Nested Schema : Kits

Type: array

Title: Kits

List of kit IDs.

Show Source

• Array of: string(uuid)

{
    "title":"Kits",
    "type":"array",
    "description":"List of kit IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Select an example Update Kit Label Group Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

Examples

Select an example Update Kit Label Group Response

400 Response

Invalid label group ID OR Invalid location OR Specify at least one filter OR Either kits or kitFilters is required. OR Invalid kit OR Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filters OR Invalid kit type OR Invalid Lot OR Invalid location

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Update Kit Label Group Bad Request Response

404 Response

Invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Update Kit Label Group Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Update Kit Label Group Server Error Response

Back to Top