Jump to

• Request
• Response

[Deprecated]: Randomize subject or dispense kit during visit

post

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit

Deprecated: Randomize a subject and/or dispense kits during a randomization or dispensation visit. This version of the API enables to return locallySourced and quantity field in response to support local sourcing.

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 : schema

Type: object

Show Source

• blind_rand_number_enabled: string
  Title: blind_rand_number_enabled

  Check if rand number needs to be blinded

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

  Instance number of the unscheduled visit

  Example: 2
• isVisitWithinWindow: boolean
  Title: isVisitWithinWindow

  Value if visit is within window

  Example: true
• kitTypesForDoseHold: array kitTypesForDoseHold
• kitTypesForResumeDispensation: array kitTypesForResumeDispensation
• notify_dispensation_failure_only: string
  Title: notify_dispensation_failure_only

  Send dispensation failure notification

  Example: true
• notify_randomization_failure_only: string
  Title: notify_randomization_failure_only

  Send randomization failure notification

  Example: true
• notifyDispensationFailureOnly: string
• notifyRandomizationFailureOnly: string
• parameters: array parameters
• resumePartialDispensation: boolean
  Title: resumePartialDispensation

  Resume partial dispensation

  Example: false
• reusableKits: array reusableKits
  Unique Items Required: true
• siteId(required): string (uuid)
  ID of the site
• studyVersion(required): string
  Version of the study

  Example: 1.0.0.5
• subjectId(required): string
  ID of the subject

  Example: B1B8327AFAA6412287106192AB5984EF
• subjects: object subjects
• titrationOption: string
  Allowed Values: [ "up", "down", "maintain" ]

  Pattern: up|down|maintain

  Titration Option

  Example: up
• userConfirmationTaken: boolean
  User confirmation for titration.

  Example: true
• visitId(required): string (uuid)
  ID of the visit
• visits: array visits
• visitTimestamp: string
  Pattern: (\d){4}-(\d){2}-(\d){2} (\d){2}:(\d){2}:(\d){2}

  Visit date and time

  Example: 2018-11-23 08:43:01

{
    "required":[
        "siteId",
        "studyVersion",
        "subjectId",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"ID  of the subject",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Version of the study",
            "example":"1.0.0.5"
        },
        "visitTimestamp":{
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2} (\\d){2}:(\\d){2}:(\\d){2}",
            "type":"string",
            "description":"Visit date and time",
            "example":"2018-11-23 08:43:01"
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Parameter"
            }
        },
        "reusableKits":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string",
                "description":"ID of the kit",
                "format":"uuid"
            }
        },
        "notifyDispensationFailureOnly":{
            "type":"string"
        },
        "notifyRandomizationFailureOnly":{
            "type":"string"
        },
        "titrationOption":{
            "pattern":"up|down|maintain",
            "type":"string",
            "description":"Titration Option",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "userConfirmationTaken":{
            "type":"boolean",
            "description":"User confirmation for titration.",
            "example":true
        },
        "instanceNumber":{
            "minimum":1,
            "type":"number",
            "description":"Instance number of the unscheduled visit",
            "format":"BigDecimal",
            "example":2
        },
        "kitTypesForDoseHold":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/kitTypesForDoseHold"
            }
        },
        "kitTypesForResumeDispensation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/kitTypesForResumeDispensation"
            }
        },
        "resumePartialDispensation":{
            "title":"resumePartialDispensation",
            "type":"boolean",
            "description":"Resume partial dispensation",
            "example":false
        },
        "notify_dispensation_failure_only":{
            "title":"notify_dispensation_failure_only",
            "type":"string",
            "description":"Send dispensation failure notification",
            "example":"true"
        },
        "notify_randomization_failure_only":{
            "title":"notify_randomization_failure_only",
            "type":"string",
            "description":"Send randomization failure notification",
            "example":"true"
        },
        "isVisitWithinWindow":{
            "title":"isVisitWithinWindow",
            "type":"boolean",
            "description":"Value if visit is within window",
            "example":true
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/visits"
            }
        },
        "subjects":{
            "$ref":"#/components/schemas/subjects"
        },
        "blind_rand_number_enabled":{
            "title":"blind_rand_number_enabled",
            "type":"string",
            "description":"Check if rand number needs to be blinded",
            "example":"true"
        }
    }
}

Nested Schema : kitTypesForDoseHold

Type: array

Show Source

• Array of: object kitTypesForDoseHold

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/kitTypesForDoseHold"
    }
}

Nested Schema : kitTypesForResumeDispensation

Type: array

Show Source

• Array of: object kitTypesForResumeDispensation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/kitTypesForResumeDispensation"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object Parameter
  Contains details about parameters of the form

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Parameter"
    }
}

Nested Schema : reusableKits

Type: array

Unique Items Required: true

Show Source

• Array of: string(uuid)
  ID of the kit

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string",
        "description":"ID of the kit",
        "format":"uuid"
    }
}

Nested Schema : subjects

Type: object

Show Source

• associatedStudyVersion: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• eventId: string
• eventInstanceNum: integer (int32)
• eventType: string
• freezedStatus: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• repeatingFormCount: number
• scheduledWindowEndDate: string (date-time)
• scheduledWindowStartDate: string (date-time)
• signedStatus: string
• siteId: string
• softwareVersionNumber: number
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100
• subjectId: string
• userId: string (uuid)
• verifiedStatus: string
• versionEnd: string (date-time)
• versionStart: string (date-time)
• visitStartDate: string (date-time)
• visitStatus: string
• visitType: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "visitStatus":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "associatedStudyVersion":{
            "type":"string"
        }
    }
}

Nested Schema : visits

Type: array

Show Source

• Array of: object visits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/visits"
    }
}

Nested Schema : kitTypesForDoseHold

Type: object

Show Source

• deviceType: string
  deviceType

  Example: Scale
• isTitration: boolean
  isTitration
• isUnblindedPharmacist: boolean
• kitTypeSrcId: string (uuid)
  kitTypeSrcId of the kit
• trialSupplyType: string
  trialSupplyType

  Example: BOTTLE

{
    "type":"object",
    "properties":{
        "isUnblindedPharmacist":{
            "type":"boolean"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitTypeSrcId of the kit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"trialSupplyType",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"deviceType",
            "example":"Scale"
        },
        "isTitration":{
            "type":"boolean",
            "description":"isTitration"
        }
    }
}

Nested Schema : kitTypesForResumeDispensation

Type: object

Show Source

• deviceType: string
  deviceType

  Example: Scale
• isTitration: boolean
  isTitration
• isUnblindedPharmacist: boolean
• kitTypeSrcId: string (uuid)
  kitTypeSrcId of the kit
• trialSupplyType: string
  trialSupplyType

  Example: BOTTLE

{
    "type":"object",
    "properties":{
        "isUnblindedPharmacist":{
            "type":"boolean"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitTypeSrcId of the kit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"trialSupplyType",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"deviceType",
            "example":"Scale"
        },
        "isTitration":{
            "type":"boolean",
            "description":"isTitration"
        }
    }
}

Nested Schema : Parameter

Type: object

Contains details about parameters of the form

Show Source

• formId: string (uuid)
  ID of the form
• itemId: string (uuid)
  ID of the item
• value: string (uuid)
  Value of the item

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"ID of the form",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"ID of the item",
            "format":"uuid"
        },
        "value":{
            "type":"string",
            "description":"Value of the item",
            "format":"uuid"
        }
    },
    "description":"Contains details about parameters of the form"
}

Nested Schema : visits

Type: object

Show Source

• associatedStudyVersion: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• eventId: string
• eventInstanceNum: integer (int32)
• eventType: string
• freezedStatus: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• repeatingFormCount: number
• scheduledWindowEndDate: string (date-time)
• scheduledWindowStartDate: string (date-time)
• signedStatus: string
• siteId: string
• softwareVersionNumber: number
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100
• subjectId: string
• userId: string (uuid)
• verifiedStatus: string
• versionEnd: string (date-time)
• versionStart: string (date-time)
• visitStartDate: string (date-time)
• visitStatus: string
• visitType: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "visitStatus":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "associatedStudyVersion":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : VisitResult

Type: object

Show Source

• countOfKitTypesOnDoseHold: integer (int32)
  countOfKitTypesOnDoseHold.

  Example: 1
• kits: array kits
• needsToVisitPharmacist: boolean
  Unblinded pharmacist kit

  Example: true
• pendingKitQuantity: integer (int32)
  pendingKitQuantity.

  Example: 1
• randomNumber: string
  Random Number

  Example: 10
• treatmentTitle: string
  Treatment Title

  Example: A
• visitTimestamp: string (date-time)
  Visit Timestamp

{
    "type":"object",
    "properties":{
        "randomNumber":{
            "type":"string",
            "description":"Random Number",
            "example":"10"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/kits"
            }
        },
        "visitTimestamp":{
            "type":"string",
            "description":"Visit Timestamp",
            "format":"date-time"
        },
        "treatmentTitle":{
            "type":"string",
            "description":"Treatment Title",
            "example":"A"
        },
        "needsToVisitPharmacist":{
            "type":"boolean",
            "description":"Unblinded pharmacist kit",
            "example":true
        },
        "countOfKitTypesOnDoseHold":{
            "type":"integer",
            "description":"countOfKitTypesOnDoseHold.",
            "format":"int32",
            "example":1
        },
        "pendingKitQuantity":{
            "type":"integer",
            "description":"pendingKitQuantity.",
            "format":"int32",
            "example":1
        }
    }
}

Nested Schema : kits

Type: array

Show Source

• Array of: object DispensationKit
  Title: DispensationKit

  Contains information for the kit dispensation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/kits"
    }
}

Nested Schema : DispensationKit

Type: object

Title: DispensationKit

Contains information for the kit dispensation

Show Source

• barcode: string
  Barcode for kit

  Example: 1000
• conserved: boolean
  Conserved for dispensation

  Example: true
• consumeAcrossDoses: boolean
  Indicate if consume across dosed allowed.

  Example: true
• deviceConnection: string
  Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

  Device Connection Type

  Example: DevicetoCloud
• deviceType: string
  Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

  Device Type

  Example: ActivityWatch
• dispensationConfirmed: string
  Barcode confirmation while dispensing kit

  Example: 1000
• dose: number (double)
  Dose.

  Example: 5
• dosingUnblinded: boolean
  Indicate if unblinded or blinded.

  Example: true
• frequency: string
  Allowed Values: [ "Once", "QD", "BID", "TID", "QID", "Q3", "Q4", "Q8", "Q12", "Q24", "Bedtime", "With meals", "With meals and at bedtime" ]

  Dosing frequency.

  Example: BID
• groupingNumber: integer (int32)
  Grouping number for a kit.

  Example: 1
• id: number (Integer)
  Id of the dispensing kit.

  Example: 2
• inventoryId: string
  Inventory Id

  Example: D313327EF13845169A8ADADDA435431E
• kitDescription: string
  Kit description

  Example: Kit A
• kitNumberUTF: string
  Alpha-numeric KitNumber

  Example: A-1
• locallySourced: boolean
  Kit is locally sourced

  Example: true
• lotId: string
  Lot Id

  Example: D313327EF13845169A8ADADDA435431E
• lotNumber: string
  Lot Number

  Example: LOT20240605A
• measurement: string
  Dose Measurement.

  Example: ml
• quantity: number (double)
  kit quantity.

  Example: 5
• titrationKitLabel: string
  Titration Kit Label

  Example: High dose
• titrationOption: string
  Allowed Values: [ "up", "down", "maintain" ]

  Titration Option

  Example: up
• trialSupplyType: string
  Trial Supply Type

  Example: BOTTLE

{
    "title":"DispensationKit",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Id of the dispensing kit.",
            "format":"Integer",
            "example":2
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "example":"Kit A"
        },
        "dose":{
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":5
        },
        "measurement":{
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "type":"string",
            "description":"Dosing frequency.",
            "example":"BID",
            "enum":[
                "Once",
                "QD",
                "BID",
                "TID",
                "QID",
                "Q3",
                "Q4",
                "Q8",
                "Q12",
                "Q24",
                "Bedtime",
                "With meals",
                "With meals and at bedtime"
            ]
        },
        "consumeAcrossDoses":{
            "type":"boolean",
            "description":"Indicate if consume across dosed allowed.",
            "example":true
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"ActivityWatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Device Connection Type",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "conserved":{
            "type":"boolean",
            "description":"Conserved for dispensation",
            "example":true
        },
        "titrationKitLabel":{
            "type":"string",
            "description":"Titration Kit Label",
            "example":"High dose"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode for kit",
            "example":"1000"
        },
        "dispensationConfirmed":{
            "type":"string",
            "description":"Barcode confirmation while dispensing kit",
            "example":"1000"
        },
        "groupingNumber":{
            "type":"integer",
            "description":"Grouping number for a kit.",
            "format":"int32",
            "example":1
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Alpha-numeric KitNumber",
            "example":"A-1"
        },
        "dosingUnblinded":{
            "type":"boolean",
            "description":"Indicate if unblinded or blinded.",
            "example":true
        },
        "titrationOption":{
            "type":"string",
            "description":"Titration Option",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "locallySourced":{
            "type":"boolean",
            "description":"Kit is locally sourced",
            "example":true
        },
        "quantity":{
            "type":"number",
            "description":"kit quantity.",
            "format":"double",
            "example":5
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot Number",
            "example":"LOT20240605A"
        }
    },
    "description":"Contains information for the kit dispensation"
}

400 Response

Invalid visit timestamp. Or you must associate the randomization design with a visit before you can create/upload a randomization list for it Or the next step in this visit isn???t allowed for subject because the study version at your site isn???t compatible with the subject Or subject can't be re-randomized before randomization. Or this operation is not allowed in the current subject status

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

404 Response

Invalid study ID or version. Or randomization ist not found or design not found

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

500 Response

Unsupported visit. Or subject already completed the visit. Or subject is randomized in error Or invalid treatment found for the subject. Or visit out of order. Or this operation is not allowed in the current subject status Or visit is outside visit window. Or visit is outside visit window and at least one kit is configured not to dispense outside visit window Or not enough inventory.

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