• comment: string
  Comment
• enabled: boolean
  Enabled

  Example: true
• endingVisitInstanceNumber: number
  Ending Visit Instance Number

  Example: 3
• endingVisitSrcId: string (uuid)
  Ending Visit Id
• kitTypeSrcId: string (uuid)
  Kittypesrc id for each Kit
• objectVersionNumber: number (BigDecimal)
  Object Version Number
• operationType: string
  operation Type
• partialDispSettingId: string (uuid)
• reason: string
  Reason
• startingVisitInstanceNumber: number
  Starting Visit Instance Number

  Example: 1
• startingVisitSrcId: string (uuid)
  Starting Visit Id
• userId: string (uuid)
  User id for each User
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"PartialDispensationResponse",
    "type":"object",
    "properties":{
        "partialDispSettingId":{
            "type":"string",
            "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 for each User",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kittypesrc id for each Kit",
            "format":"uuid"
        },
        "startingVisitSrcId":{
            "type":"string",
            "description":"Starting Visit Id",
            "format":"uuid"
        },
        "startingVisitInstanceNumber":{
            "type":"number",
            "description":"Starting Visit Instance Number",
            "example":1
        },
        "endingVisitSrcId":{
            "type":"string",
            "description":"Ending Visit Id",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "type":"number",
            "description":"Ending Visit Instance Number",
            "example":3
        },
        "enabled":{
            "type":"boolean",
            "description":"Enabled",
            "example":true
        }
    },
    "description":"Response containing partial dispensation settings"
}

• 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."
}

• 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."
        }
    },
    "description":"Error Response Details Information"
}