Jump to

• Request
• Response

v2.0

get

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

Retrieves dose hold setting details of given dose hold identified by ID including last visit. Rights required:SupplySettingRightsGet.

Request

Path Parameters

• id(required): string
  Dose Hold ID.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• 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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DoseHoldSettingsResponseTO v2.0

Type: object

Title: DoseHoldSettingsResponseTO v2.0

Response containing dose hold settings.

Show Source

• comment: string
  Comment.
• doseHoldID: string (uuid)
  Title: Dose Hold ID

  Dose hold ID.
• enabled: boolean
  Title: Enabled

  Indicates whether dose hold is enabled.
• endingVisitInstanceNumber: number (BigDecimal)
  Ending Visit Instance Number.
• endingVisitSrcId: string (uuid)
  Ending Visit Id.
• frequencyLimitInDays: number (BigDecimal)
  Title: Frequency Limit In Days

  Frequency limit in days.
• frequencyLimitInSequence: number (BigDecimal)
  Title: Frequency Limit In Sequence

  Frequency limit within a sequence.
• frequencyUnlimited: boolean
  Title: Frequency Unlimited

  Indicates whether frequency is unlimited.
• instanceNumber: number (BigDecimal)
  Title: Instance Number

  Visit instance number.
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

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

  Maximum number of allowed dose holds.
• objectVersionNumber: number (BigDecimal)
  Object version number.
• operationType: string
  Operation type.
• reason: string
  Reason.
• startingVisitSrcId: string (uuid)
  Title: Visit Source ID

  Visit source identifier.
• userID: string (uuid)
  User ID.
• versionEnd: string (date-time)
  Version end date.
• versionStart: string (date-time)
  Version start date.

{
    "title":"DoseHoldSettingsResponseTO v2.0",
    "type":"object",
    "properties":{
        "doseHoldID":{
            "title":"Dose Hold ID",
            "type":"string",
            "description":"Dose hold ID.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason."
        },
        "comment":{
            "type":"string",
            "description":"Comment."
        },
        "operationType":{
            "type":"string",
            "description":"Operation type."
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "format":"BigDecimal"
        },
        "userID":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        },
        "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"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number.",
            "format":"BigDecimal"
        },
        "enabled":{
            "title":"Enabled",
            "type":"boolean",
            "description":"Indicates whether dose hold is enabled."
        },
        "maxDoseHolds":{
            "title":"Maximum Dose Holds",
            "type":"number",
            "description":"Maximum number of allowed dose holds.",
            "format":"BigDecimal"
        },
        "frequencyUnlimited":{
            "title":"Frequency Unlimited",
            "type":"boolean",
            "description":"Indicates whether frequency is unlimited."
        },
        "frequencyLimitInSequence":{
            "title":"Frequency Limit In Sequence",
            "type":"number",
            "description":"Frequency limit within a sequence.",
            "format":"BigDecimal"
        },
        "frequencyLimitInDays":{
            "title":"Frequency Limit In Days",
            "type":"number",
            "description":"Frequency limit in days.",
            "format":"BigDecimal"
        },
        "endingVisitSrcId":{
            "type":"string",
            "description":"Ending Visit Id.",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "type":"number",
            "description":"Ending Visit Instance Number.",
            "format":"BigDecimal"
        }
    },
    "description":"Response containing dose hold settings."
}

Examples

Select an example Get Dose Hold By Id Response

400 Response

Invalid Dose Hold ID

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

Examples

Select an example Bad Request

Back to Top