Jump to

• Request
• Response

[Deprecated]: v2.0

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-disp-history

Deprecated: Retrieves unblinded dispensation history for all subjects within the study. Rights: OrsSubjectVisitGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• audit: boolean
  Value of audit parameter

  Example:

  false

• instanceNumber: number
  Instance number for unscheduled visit.

  Example:

  1

• subjectId: string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  SUBJ-001

• visitId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  Example:

  B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DispensationHistoryResponseForAllSubject v2.0

Type: object

Title: DispensationHistoryResponseForAllSubject v2.0

Contains unblinded dispensation history for all subjects.

Show Source

• barcode: string
  Barcode.

  Example: 61234
• conserved: boolean
  Conserved for dispensation.

  Example: false
• dispensationConfirmed: boolean
  Indicates whether dispensation is confirmed.

  Example: true
• dispensationDate: string (date-time)
  Dispensation date.

  Example: 2026-02-24T00:00:00Z
• dose: number
  Dose.

  Example: 1
• frequency: string
  Frequency

  Example: Once daily
• instanceNumber: number
  Title: Instance Number

  Visit instance number.

  Example: 1
• inventoryId: string (uuid)
  Inventory ID.
• inventoryStatus: string
  Name of the inventory status.

  Example: Available
• inventoryStatusId: number
  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitNumber: number
  Title: Kit Number

  Kit number.

  Example: 123
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.

  Example: KIT-000123
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• measurement: string
  Measurement unit

  Example: mg
• mHealthDeviceId: string
  mHealthDevice Id

  Example: MHEALTH-DEV-001
• missingUnits: number
  Missing units for the kit.

  Example: 0
• objectVersionNumber: number (double)
  Object version number.
• returnedUnits: number
  Returned units for the kit.

  Example: 0
• siteId: string (uuid)
  Site ID.
• subjectId: string (uuid)
  Title: Subject ID

  Subject ID.
• versionEnd: string (date-time)
  Version end date.
• versionStart: string (date-time)
  Version start date.
• visitId: string (uuid)
  Title: Visit Source ID

  Visit source identifier.

{
    "title":"DispensationHistoryResponseForAllSubject v2.0",
    "type":"object",
    "properties":{
        "subjectId":{
            "title":"Subject ID",
            "type":"string",
            "description":"Subject ID.",
            "format":"uuid"
        },
        "visitId":{
            "title":"Visit Source ID",
            "type":"string",
            "description":"Visit source identifier.",
            "format":"uuid"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number.",
            "example":1
        },
        "siteId":{
            "type":"string",
            "description":"Site ID.",
            "format":"uuid"
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit number.",
            "example":123
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "example":5
        },
        "inventoryStatus":{
            "type":"string",
            "description":"Name of the inventory status.",
            "example":"Available"
        },
        "dispensationDate":{
            "type":"string",
            "description":"Dispensation date.",
            "format":"date-time",
            "example":"2026-02-24T00:00:00Z"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode.",
            "example":"61234"
        },
        "dispensationConfirmed":{
            "type":"boolean",
            "description":"Indicates whether dispensation is confirmed.",
            "example":true
        },
        "mHealthDeviceId":{
            "type":"string",
            "description":"mHealthDevice Id",
            "example":"MHEALTH-DEV-001"
        },
        "dose":{
            "type":"number",
            "description":"Dose.",
            "example":1
        },
        "measurement":{
            "type":"string",
            "description":"Measurement unit",
            "example":"mg"
        },
        "frequency":{
            "type":"string",
            "description":"Frequency",
            "example":"Once daily"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned units for the kit.",
            "example":0
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing units for the kit.",
            "example":0
        },
        "conserved":{
            "type":"boolean",
            "description":"Conserved for dispensation.",
            "example":false
        },
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"KIT-000123"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "format":"double"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        }
    },
    "description":"Contains unblinded dispensation history for all subjects."
}

Examples

Select an example Unblinded Dispensation History Response

404 Response

Invalid study ID or version. Or subject 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

Examples

Select an example Unblinded Dispensation History Not Found Response

500 Response

Internal server error

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

Examples

Select an example Unblinded Dispensation History Server Error Response

Back to Top