Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups

Creates blinding group.
Required sponsor roles are: clinical supply manager and site manager.
Rights: SupplySettingRightsPostThe field groupDifferentPackageTypes is optional. Grouping different package types will be allowed if groupDifferentPackageTypes flag is set to Yes. Otherwise, this API operations throws an error saying that there are multiple package types in such cases.

Request

Path Parameters

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

Type: object

Title: BlindingGroupRequest

Blinding group parameters.

Show Source

• defaultBlindingKit: string
  Title: Default Blinding Kit

  ID of the default kit in the blinding group.

  Example: 392DA9F053E94B9B9339AC7D0FA0D1DB
• description(required): string
  Minimum Length: 0

  Maximum Length: 2000

  Blinding group description.

  Example: Blinded Group Lotion
• groupDifferentPackageTypes: string
  Title: Group Different Package Types

  Allowed Values: [ "Yes", "No" ]

  Indicates whether different package types are grouped.

  Example: Yes
• kitTypes(required): array kitTypes
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of kit types in the blinding group.
• title(required): string
  Minimum Length: 0

  Maximum Length: 50

  Blinding group title.

  Example: Blinded Group Lotion

{
    "title":"BlindingGroupRequest",
    "required":[
        "description",
        "kitTypes",
        "title"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Blinding group title.",
            "example":"Blinded Group Lotion"
        },
        "description":{
            "maxLength":2000,
            "minLength":0,
            "type":"string",
            "description":"Blinding group description.",
            "example":"Blinded Group Lotion"
        },
        "kitTypes":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"List of kit types in the blinding group.",
            "items":{
                "$ref":"#/components/schemas/KitType"
            }
        },
        "groupDifferentPackageTypes":{
            "title":"Group Different Package Types",
            "type":"string",
            "description":"Indicates whether different package types are grouped.",
            "example":"Yes",
            "enum":[
                "Yes",
                "No"
            ]
        },
        "defaultBlindingKit":{
            "title":"Default Blinding Kit",
            "type":"string",
            "description":"ID of the default kit in the blinding group.",
            "example":"392DA9F053E94B9B9339AC7D0FA0D1DB"
        }
    },
    "description":"Blinding group parameters."
}

Nested Schema : kitTypes

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of kit types in the blinding group.

Show Source

• Array of: object KitType
  Kit types details object.

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"List of kit types in the blinding group.",
    "items":{
        "$ref":"#/components/schemas/KitType"
    }
}

Nested Schema : KitType

Type: object

Kit types details object.

Show Source

• countsPerPackage: number (double)
  Counts per package.

  Example: 5
• description: string
  Kit type description

  Example: Non-Dosing
• doNotDispense: number (double)
  Value to indicate whether to dispense kits or not.

  Example: 1
• dosage: number (double)
  Dosage.

  Example: 1
• id: string (uuid)
  Kit type Id
• isDefault: boolean
  Indicate if kit is default.

  Example: true
• kitTypeId: string (uuid)
  Kit type Id
• kitTypeName: string
  Kit type name

  Example: Kit A
• minShippingUnits: number (double)
  Minimum Kits to Ship.

  Example: 10
• packageTypeId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

  Example: 10
• srcId: string (uuid)
  Id of the Study
• srcVersionStart: string (date-time)
  Study version start
• storageNeedId: number (double)
  Storage need ID.

  Example: 1
• studyId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
• studyVersionStart: string (date-time)
  Study version start
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kit type Id",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "countsPerPackage":{
            "type":"number",
            "description":"Counts per package.",
            "format":"double",
            "example":5
        },
        "description":{
            "type":"string",
            "description":"Kit type description",
            "example":"Non-Dosing"
        },
        "doNotDispense":{
            "type":"number",
            "description":"Value to indicate whether to dispense kits or not.",
            "format":"double",
            "example":1
        },
        "dosage":{
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":1
        },
        "minShippingUnits":{
            "type":"number",
            "description":"Minimum Kits to Ship.",
            "format":"double",
            "example":10
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":10,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicate if kit is default.",
            "example":true
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name",
            "example":"Kit A"
        },
        "storageNeedId":{
            "type":"number",
            "description":"Storage need ID.",
            "format":"double",
            "example":1
        },
        "srcId":{
            "type":"string",
            "description":"Id of the Study",
            "format":"uuid"
        },
        "srcVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "kitTypeId":{
            "type":"string",
            "description":"Kit type Id",
            "format":"uuid"
        }
    },
    "description":"Kit types details object."
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

400 Response

Validation message OR The following required parameters are missing OR Blinding Group already exist OR Invalid kit type OR Kit type ID already belongs to another blinding group OR Kit Types belong to different package types OR At least 2 kit types needed for grouping OR The following parameter values are invalid

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

Study 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