Jump to

• Request
• Response

Get unblinded dispensation history for all subjects

get

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

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

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study

Query Parameters

• instanceNumber: number
  Instance number for unscheduled visit.
• subjectId: string
  ID of the subject
• visitId: string
  ID of the visit

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 v1.0

Type: object

Title: DispensationHistoryResponseForAllSubject v1.0

Contains unblinded dispensation history for all subjects.

Show Source

• conserved: boolean
• dispensationConfirmed: boolean
• dispensationDate: string (date-time)
  Dispensation date
• dose: number (double)
  Dose.
• frequency: string
  Frequency
• instanceNumber: number (double)
  Instance number.
• inventoryId: string (uuid)
  Inventory Id.
• inventoryStatus: string
  Inventory Status
• inventoryStatusId: number (double)
  Inventory Status Id.
• kitNumberUTF: string
  Kit Number in UTF8 format.
• kitTypeSrcId: string (uuid)
  Kit Type Source Id.
• measurement: string
  Measurement unit
• mHealthDeviceId: string
  mHealthDevice Id
• missingUnits: number (double)
  Number of Missing Units.
• returnedUnits: number (double)
  Number of Return Units.
• siteId: string (uuid)
  Site Id.
• subjectId: string (uuid)
  Subject Id.
• visitId: string (uuid)
  Visit Id.

{
    "title":"DispensationHistoryResponseForAllSubject v1.0",
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Subject Id.",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"Visit Id.",
            "format":"uuid"
        },
        "instanceNumber":{
            "type":"number",
            "description":"Instance number.",
            "format":"double"
        },
        "siteId":{
            "type":"string",
            "description":"Site Id.",
            "format":"uuid"
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id.",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit Type Source Id.",
            "format":"uuid"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory Status Id.",
            "format":"double"
        },
        "inventoryStatus":{
            "type":"string",
            "description":"Inventory Status"
        },
        "dispensationDate":{
            "type":"string",
            "description":"Dispensation date",
            "format":"date-time"
        },
        "dispensationConfirmed":{
            "type":"boolean"
        },
        "mHealthDeviceId":{
            "type":"string",
            "description":"mHealthDevice Id"
        },
        "dose":{
            "type":"number",
            "description":"Dose.",
            "format":"double"
        },
        "measurement":{
            "type":"string",
            "description":"Measurement unit"
        },
        "frequency":{
            "type":"string",
            "description":"Frequency"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Number of Return Units.",
            "format":"double"
        },
        "missingUnits":{
            "type":"number",
            "description":"Number of Missing Units.",
            "format":"double"
        },
        "conserved":{
            "type":"boolean"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit Number in UTF8 format."
        }
    },
    "description":"Contains unblinded dispensation history for all subjects."
}

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

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

Back to Top