Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings

Adds partial dispensation settings. 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 : PartialDispensationSettingsRequest v1.0

Type: object

Title: PartialDispensationSettingsRequest v1.0

Request containing partial dispensation settings.

Show Source

• enabled(required): boolean
  Enabled

  Example: true
• endingVisitInstanceNumber: number
  Title: Instance Number

  Minimum Value: 1

  Maximum Value: 999

  Ending Visit Instance Number.

  Example: 3
• endingVisitSrcId: string (uuid)
  Title: Visit Source ID

  Ending Visit Id.
• kitTypeSrcIds(required): array kitTypeSrcIds
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Unique Items Required: true
• startingVisitInstanceNumber: number
  Title: Instance Number

  Minimum Value: 1

  Maximum Value: 999

  Visit instance number.

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

  Visit source identifier.

{
    "title":"PartialDispensationSettingsRequest v1.0",
    "required":[
        "enabled",
        "kitTypeSrcIds",
        "startingVisitSrcId"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcIds":{
            "maxItems":2147483647,
            "minItems":1,
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "startingVisitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid"
        },
        "startingVisitInstanceNumber":{
            "title":"Instance Number",
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Visit instance number.",
            "example":1
        },
        "endingVisitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Ending Visit Id.",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "title":"Instance Number",
            "maximum":999,
            "minimum":1,
            "type":"number",
            "description":"Ending Visit Instance Number.",
            "example":3
        },
        "enabled":{
            "type":"boolean",
            "description":"Enabled",
            "example":true
        }
    },
    "description":"Request containing partial dispensation settings."
}

Nested Schema : kitTypeSrcIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

Show Source

• Array of: string(uuid)

{
    "maxItems":2147483647,
    "minItems":1,
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : PartialDispensationSettingsResponse v1.0

Type: object

Title: PartialDispensationSettingsResponse v1.0

Response containing partial dispensation settings.

Show Source

• comment: string
  Title: Comment

  Comment.
• enabled: boolean
  Title: Enabled

  Indicates whether dose hold is enabled.

  Example: true
• endingVisitInstanceNumber: number
  Title: Instance Number

  Ending Visit Instance Number.

  Example: 3
• endingVisitSrcId: string (uuid)
  Title: Visit Source ID

  Ending Visit Id.
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• objectVersionNumber: number
  Title: Object Version Number

  Object version number.
• operationType: string
  Title: Operation Type

  Operation type.
• partialDispSettingId: string (uuid)
  ID
• reason: string
  Title: Reason

  Reason.
• startingVisitInstanceNumber: number
  Title: Instance Number

  Visit instance number.

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

  Visit source identifier.
• userId: string (uuid)
  Title: User ID

  User ID.
• versionEnd: string (date-time)
  Title: Version End

  Version end date.
• versionStart: string (date-time)
  Title: Version Start

  Version start date.

{
    "title":"PartialDispensationSettingsResponse v1.0",
    "type":"object",
    "properties":{
        "partialDispSettingId":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason."
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment."
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation type."
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Object version number."
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "versionEnd":{
            "title":"Version End",
            "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"
        },
        "startingVisitInstanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number.",
            "example":1
        },
        "endingVisitSrcId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Ending Visit Id.",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Ending Visit Instance Number.",
            "example":3
        },
        "enabled":{
            "title":"Enabled",
            "type":"boolean",
            "description":"Indicates whether dose hold is enabled.",
            "example":true
        }
    },
    "description":"Response containing partial dispensation settings."
}

400 Response

Invalid Partial Dispensation 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