Jump to

• Request
• Response

Create dose hold settings for the given dose hold

post

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

Adds dose hold setting for a given dose hold. Rights required:SupplySettingRightsPost

Request

Path Parameters

• 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 : DoseHoldRequest

Type: object

Title: DoseHoldRequest

Request containing dose hold settings

Show Source

• enabled(required): boolean
  Enabled

  Example: true
• endingVisitInstanceNumber: number
  Minimum Value: 1

  Maximum Value: 999

  Ending Visit Instance Number

  Example: 3
• endingVisitSrcId: string (uuid)
  Ending Visit Id
• frequencyLimitInDays: number
  Minimum Value: 1

  Maximum Value: 999

  Frequency LimitInDays

  Example: 800
• frequencyLimitInSequence: number
  Minimum Value: 1

  Maximum Value: 999

  Frequency LimitInSequence

  Example: 800
• frequencyUnlimited: boolean
  FrequencyUnlimited

  Example: true
• instanceNumber: number
  Minimum Value: 1

  Maximum Value: 999

  Instance Number

  Example: 5
• kitTypeSrcId(required): string (uuid)
  Kit Type Id
• maxDoseHolds: number
  Minimum Value: 1

  Maximum Value: 999

  Maximum DoseHolds

  Example: 800
• startingVisitSrcId(required): string (uuid)
  Starting Visit Id

{
    "title":"DoseHoldRequest",
    "required":[
        "enabled",
        "kitTypeSrcId",
        "startingVisitSrcId"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit Type Id",
            "format":"uuid"
        },
        "startingVisitSrcId":{
            "type":"string",
            "description":"Starting Visit Id",
            "format":"uuid"
        },
        "enabled":{
            "type":"boolean",
            "description":"Enabled",
            "example":true
        },
        "frequencyUnlimited":{
            "type":"boolean",
            "description":"FrequencyUnlimited",
            "example":true
        },
        "instanceNumber":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Instance Number",
            "example":"5"
        },
        "maxDoseHolds":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Maximum DoseHolds",
            "example":"800"
        },
        "frequencyLimitInSequence":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Frequency LimitInSequence",
            "example":"800"
        },
        "frequencyLimitInDays":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Frequency LimitInDays",
            "example":"800"
        },
        "endingVisitSrcId":{
            "type":"string",
            "description":"Ending Visit Id",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Ending Visit Instance Number",
            "example":"3"
        }
    },
    "description":"Request containing dose hold settings"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DoseHoldResponse

Type: object

Show Source

• doseHoldId: string (uuid)

{
    "type":"object",
    "properties":{
        "doseHoldId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

400 Response

Invalid Dose Hold Setting Details

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