Jump to

• Request
• Response

Get unblinded dispensation history for all subjects

get

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

Retrieves unblinded dispensation history for all subjects within the study. This version includes new fields in response for non-serialized kits:

• subjectVisitNsInventoryId
lotId
• quantity
• lotNumber
• nsInventoryVersionStart
• visitManualAssignment
• nsInventoryId
• userId
• originalSubjectVisitNSInventory
• notDispensedToSubject

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

• audit: boolean
  Value of audit parameter
• instanceNumber: number
  Instance number for unscheduled visit.
• limit: integer(int32)
  Maximum number of records to display per page.
• offset: integer(int32)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter
• 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 : PaginatedResponse

Type: object

Show Source

• count: integer (int32)
• hasMore: boolean
• limit: integer (int32)
• offset: integer (int32)
• resultData: object resultData
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        },
        "resultData":{
            "type":"object"
        }
    }
}

Nested Schema : resultData

Type: object

400 Response

Invalid limit or offset values

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