Jump to

• Request
• Response

[Deprecated]: Randomize subject or dispense kit during visit

post

/ec-ors-svc/rest/v16.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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : VisitRequest v100.0

Type: object

Title: VisitRequest v100.0

Visit Request.

Show Source

• instanceNumber: number (BigDecimal)
  Minimum Value: 1

  Instance number of the unscheduled visit

  Example: 2
• kitTypesForDoseHold: object kitTypesForDoseHold
  Contains details about kits which are to be hold or dispensed
• kitTypesForResumeDispensation: object kitTypesForResumeDispensation
  Contains details about kits which are to be hold or dispensed
• parameters: object Parameter
  Contains details about parameters of the form
• resumePartialDispensation: boolean
  Title: resumePartialDispensation

  Resume partial dispensation

  Example: false
• reusableKits: array reusableKits
  Unique Items Required: true
• siteId(required): string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• studyVersion(required): string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.5
• subjectId(required): string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: B1B8327AFAA6412287106192AB5984EF
• 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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit
• 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

{
    "title":"VisitRequest v100.0",
    "required":[
        "siteId",
        "studyVersion",
        "subjectId",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "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":{
            "$ref":"#/components/schemas/Parameter"
        },
        "reusableKits":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string",
                "description":"ID of the kit",
                "format":"uuid"
            }
        },
        "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":{
            "$ref":"#/components/schemas/kitTypesForDoseHold"
        },
        "kitTypesForResumeDispensation":{
            "$ref":"#/components/schemas/kitTypesForResumeDispensation"
        },
        "resumePartialDispensation":{
            "title":"resumePartialDispensation",
            "type":"boolean",
            "description":"Resume partial dispensation",
            "example":false
        }
    },
    "description":"Visit Request."
}

Nested Schema : kitTypesForDoseHold

Type: object

Contains details about kits which are to be hold or dispensed

Show Source

• deviceType: string
  type of device being used.These can be Activity watch, Blood pressure monitor, Weight scale, ECG reader, Spirometer, Mobile App, Smart Pill Bottle, Pulse Oximeter, Wearable Patch

  Example: Spirometer
• isTitration: boolean
  is current medication a titration

  Example: true
• isUnblindedPharmacist: boolean
  treatment assignment information that is can be or can not be visible to study personne

  Example: true
• kitTypeSrcId: string (uuid)
  kitTypeSrcId (UUID, 32-character uppercase hexadecimal string) of the kit
• trialSupplyType: string
  trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX

  Example: BOTTLE

{
    "type":"object",
    "properties":{
        "isUnblindedPharmacist":{
            "type":"boolean",
            "description":"treatment assignment information that is can be or can not be visible to study personne",
            "example":true
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitTypeSrcId  (UUID, 32-character uppercase hexadecimal string) of the kit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"type of device being used.These can be Activity watch, Blood pressure monitor, Weight scale, ECG reader, Spirometer, Mobile App, Smart Pill Bottle, Pulse Oximeter, Wearable Patch",
            "example":"Spirometer"
        },
        "isTitration":{
            "type":"boolean",
            "description":"is current medication a titration",
            "example":true
        }
    },
    "description":"Contains details about kits which are to be hold or dispensed"
}

Nested Schema : kitTypesForResumeDispensation

Type: object

Contains details about kits which are to be hold or dispensed

Show Source

• deviceType: string
  type of device being used.These can be Activity watch, Blood pressure monitor, Weight scale, ECG reader, Spirometer, Mobile App, Smart Pill Bottle, Pulse Oximeter, Wearable Patch

  Example: Spirometer
• isTitration: boolean
  is current medication a titration

  Example: true
• isUnblindedPharmacist: boolean
  treatment assignment information that is can be or can not be visible to study personne

  Example: true
• kitTypeSrcId: string (uuid)
  kitTypeSrcId (UUID, 32-character uppercase hexadecimal string) of the kit
• trialSupplyType: string
  trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX

  Example: BOTTLE

{
    "type":"object",
    "properties":{
        "isUnblindedPharmacist":{
            "type":"boolean",
            "description":"treatment assignment information that is can be or can not be visible to study personne",
            "example":true
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitTypeSrcId  (UUID, 32-character uppercase hexadecimal string) of the kit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"type of device being used.These can be Activity watch, Blood pressure monitor, Weight scale, ECG reader, Spirometer, Mobile App, Smart Pill Bottle, Pulse Oximeter, Wearable Patch",
            "example":"Spirometer"
        },
        "isTitration":{
            "type":"boolean",
            "description":"is current medication a titration",
            "example":true
        }
    },
    "description":"Contains details about kits which are to be hold or dispensed"
}

Nested Schema : Parameter

Type: object

Contains details about parameters of the form

Show Source

• formId: string (uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
• itemId: string (uuid)
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
• value: string (uuid)
  Value of the item

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"uuid"
        },
        "value":{
            "type":"string",
            "description":"Value of the item",
            "format":"uuid"
        }
    },
    "description":"Contains details about parameters of the form"
}

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

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: object DispensationKit
  Title: DispensationKit

  Contains information for the kit dispensation
• 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
  Visit Timestamp

  Example: 23-NOV-2018 08.43.01.700136000 AM

{
    "type":"object",
    "properties":{
        "randomNumber":{
            "type":"string",
            "description":"Random Number",
            "example":"10"
        },
        "kits":{
            "title":"DispensationKit",
            "type":"object",
            "properties":{
                "id":{
                    "type":"number",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) 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":"Trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX",
                    "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  (UUID, 32-character uppercase hexadecimal string)",
                    "example":"D313327EF13845169A8ADADDA435431E"
                },
                "lotNumber":{
                    "type":"string",
                    "description":"Lot Number",
                    "example":"LOT20240605A"
                },
                "dosingInstruction":{
                    "type":"string",
                    "description":"Dosing Instruction",
                    "example":"Take one capsule daily"
                }
            },
            "description":"Contains information for the kit dispensation"
        },
        "visitTimestamp":{
            "type":"string",
            "description":"Visit Timestamp",
            "example":"23-NOV-2018 08.43.01.700136000 AM"
        },
        "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 : 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
• dosingInstruction: string
  Dosing Instruction

  Example: Take one capsule daily
• 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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) 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 (UUID, 32-character uppercase hexadecimal string)

  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
  Trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX

  Example: BOTTLE

{
    "title":"DispensationKit",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) 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":"Trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX",
            "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  (UUID, 32-character uppercase hexadecimal string)",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot Number",
            "example":"LOT20240605A"
        },
        "dosingInstruction":{
            "type":"string",
            "description":"Dosing Instruction",
            "example":"Take one capsule daily"
        }
    },
    "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
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

404 Response

Invalid study ID or version OR Rand List not found OR Design not found

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

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
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top