Jump to

• Request
• Response

Create partial dispensation settings

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)
  ID of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : PartialDispensationRequest

Type: object

Title: PartialDispensationRequest

Request containing partial dispensation settings

Show Source

• enabled(required): boolean
  Enabled

  Example: true
• endingVisitInstanceNumber: number
  Minimum Value: 1

  Maximum Value: 999

  Ending Visit Instance Number

  Example: 10
• endingVisitSrcId: string (uuid)
  Ending Visit Id
• kitTypeSrcId: string (uuid)
  kitTypeSrcId of the kit
• startingVisitInstanceNumber: number
  Minimum Value: 1

  Maximum Value: 999

  Starting Visit Instance Number

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

{
    "title":"PartialDispensationRequest",
    "required":[
        "enabled",
        "startingVisitSrcId"
    ],
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitTypeSrcId of the kit",
            "format":"uuid"
        },
        "startingVisitSrcId":{
            "type":"string",
            "description":"Starting Visit Id",
            "format":"uuid"
        },
        "startingVisitInstanceNumber":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Starting Visit Instance Number",
            "example":"1"
        },
        "endingVisitSrcId":{
            "type":"string",
            "description":"Ending Visit Id",
            "format":"uuid"
        },
        "endingVisitInstanceNumber":{
            "maximum":"999",
            "minimum":"1",
            "type":"number",
            "description":"Ending Visit Instance Number",
            "example":"10"
        },
        "enabled":{
            "type":"boolean",
            "description":"Enabled",
            "example":true
        }
    },
    "description":"Request containing partial dispensation settings"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : PartialDispensationResponse

Type: object

Title: PartialDispensationResponse

Response containing partial dispensation settings

Show Source

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

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