Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/supply/settings/combination-dosing

Create a manual combination kit dosing definition.

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:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Manual combination kit dosing create request.

Show Source

• combinationKitSrcId(required): string (uuid)
• doses(required): array doses

{
    "required":[
        "combinationKitSrcId",
        "doses"
    ],
    "type":"object",
    "properties":{
        "combinationKitSrcId":{
            "type":"string",
            "format":"uuid"
        },
        "doses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CombinationKitDosingDoseRequest"
            }
        }
    },
    "description":"Manual combination kit dosing create request."
}

Nested Schema : doses

Type: array

Show Source

• Array of: object CombinationKitDosingDoseRequest
  Manual combination kit dosing dose request.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CombinationKitDosingDoseRequest"
    }
}

Nested Schema : CombinationKitDosingDoseRequest

Type: object

Manual combination kit dosing dose request.

Show Source

• doseTitle(required): string
• id: string (uuid)
• optionGroups(required): array optionGroups
  Minimum Number of Items: 0

  Maximum Number of Items: 10

{
    "required":[
        "doseTitle",
        "optionGroups"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "doseTitle":{
            "type":"string"
        },
        "optionGroups":{
            "maxItems":10,
            "minItems":0,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CombinationKitDosingOptionGroupRequest"
            }
        }
    },
    "description":"Manual combination kit dosing dose request."
}

Nested Schema : optionGroups

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 10

Show Source

• Array of: object CombinationKitDosingOptionGroupRequest
  Manual combination kit dosing option group request.

{
    "maxItems":10,
    "minItems":0,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CombinationKitDosingOptionGroupRequest"
    }
}

Nested Schema : CombinationKitDosingOptionGroupRequest

Type: object

Manual combination kit dosing option group request.

Show Source

• combinationDosingRowGroupId: string (uuid)
• displayOrder: integer (int32)
  Minimum Value: 1
• rows(required): array rows

{
    "required":[
        "rows"
    ],
    "type":"object",
    "properties":{
        "combinationDosingRowGroupId":{
            "type":"string",
            "format":"uuid"
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "format":"int32"
        },
        "rows":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CombinationKitDosingRowRequest"
            }
        }
    },
    "description":"Manual combination kit dosing option group request."
}

Nested Schema : rows

Type: array

Show Source

• Array of: object CombinationKitDosingRowRequest
  Manual combination kit dosing row request.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CombinationKitDosingRowRequest"
    }
}

Nested Schema : CombinationKitDosingRowRequest

Type: object

Manual combination kit dosing row request.

Show Source

• kitTypeSrcId(required): string (uuid)
• quantity(required): number
  Minimum Value: 0

  Minimum Value: > true

{
    "required":[
        "kitTypeSrcId",
        "quantity"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "type":"string",
            "format":"uuid"
        },
        "quantity":{
            "minimum":0,
            "exclusiveMinimum":true,
            "type":"number"
        }
    },
    "description":"Manual combination kit dosing row request."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : CombinationKitDosingCreateResponse

Type: object

Manual combination kit dosing create response.

Show Source

• id: string (uuid)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Manual combination kit dosing create response."
}

400 Response

Bad request.

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top