Jump to

• Request
• Response

v2.0

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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : DoseHoldSettingsRequest v2.0

Type: object

Title: DoseHoldSettingsRequest v2.0

Request containing dose hold settings.

Show Source

• enabled(required): boolean
  Title: Enabled

  Indicates whether dose hold is enabled.

  Example: true
• endingVisitInstanceNumber: number (BigDecimal)
  Minimum Value: 1

  Maximum Value: 999

  Ending Visit Instance Number.

  Example: 3
• endingVisitSrcId: string (uuid)
  Ending Visit Id.
• frequencyLimitInDays: number (double)
  Title: Frequency Limit In Days

  Minimum Value: 1

  Maximum Value: 999

  Frequency limit in days.

  Example: 800
• frequencyLimitInSequence: number (double)
  Title: Frequency Limit In Sequence

  Minimum Value: 1

  Maximum Value: 999

  Frequency limit within a sequence.

  Example: 800
• frequencyUnlimited: boolean
  Title: Frequency Unlimited

  Indicates whether frequency is unlimited.

  Example: true
• instanceNumber: number (double)
  Title: Instance Number

  Minimum Value: 1

  Maximum Value: 999

  Visit instance number.

  Example: 5
• kitTypeSrcId(required): string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• maxDoseHolds: number (double)
  Title: Maximum Dose Holds

  Minimum Value: 1

  Maximum Value: 999

  Maximum number of allowed dose holds.

  Example: 800
• startingVisitSrcId(required): string (uuid)
  Title: Visit Source ID

  Visit source identifier.

{
    "title":"DoseHoldSettingsRequest v2.0",
    "required":[
        "enabled",
        "kitTypeSrcId",
        "startingVisitSrcId"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "startingVisitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid"
        },
        "enabled":{
            "title":"Enabled",
            "type":"boolean",
            "description":"Indicates whether dose hold is enabled.",
            "example":true
        },
        "frequencyUnlimited":{
            "title":"Frequency Unlimited",
            "type":"boolean",
            "description":"Indicates whether frequency is unlimited.",
            "example":true
        },
        "instanceNumber":{
            "title":"Instance Number",
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Visit instance number.",
            "format":"double",
            "example":5
        },
        "maxDoseHolds":{
            "title":"Maximum Dose Holds",
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Maximum number of allowed dose holds.",
            "format":"double",
            "example":800
        },
        "frequencyLimitInSequence":{
            "title":"Frequency Limit In Sequence",
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Frequency limit within a sequence.",
            "format":"double",
            "example":800
        },
        "frequencyLimitInDays":{
            "title":"Frequency Limit In Days",
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Frequency limit in days.",
            "format":"double",
            "example":800
        },
        "endingVisitSrcId":{
            "type":"string",
            "description":"Ending Visit Id.",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Ending Visit Instance Number.",
            "format":"BigDecimal",
            "example":3
        }
    },
    "description":"Request containing dose hold settings."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Dose Hold Response

Type: object

Title: Dose Hold Response

Response containing the created or updated dose hold identifier.

Show Source

• doseHoldId: string (uuid)

{
    "title":"Dose Hold Response",
    "type":"object",
    "properties":{
        "doseHoldId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Response containing the created or updated dose hold identifier."
}

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