GetUserReports
Retrieves a list of Blue reports accessible to a particular user.
URL
../
Method
GET
Inputs
Inputs for GetUserReports API
| Input Parameters | Type | Description |
|---|---|---|
| pathway | string | Blue |
| userid | string | The unique identification of a user whose report is required. |
| Optional parameters (category, subcategory, ID, title, other fields defined in the BPI report pathway) | string | The optional parameters are used to filter the report list to find a specific report. |
Outputs
Outputs for GetUserReports API
| Output Properties | Type | Description |
|---|---|---|
| StatusCode | int | Other status codes will be reserved for future use as required. |
| Message | string | Reserved for future use. |
| BLUE_PUB_REPORT | List | List of report objects. (See table below for more information.) |
Output Format for the Reports object
Outputs for Reports Object
| Output Properties | Type | Order | Description |
|---|---|---|---|
| ID | string | 1 | Blue |
| Title | string | 2 | Blue |
| ParentReportTitle | string | 3 | Blue |
| Category | string | 4 | Blue |
| SubCategory | string | 5 | Blue |
| CourseID | string | 6 | The course ID for a child report. |
| InstructorID | string | 7 | The instructor ID for a child report, which does not show by default. |
| Link | string | 8 | The report link url. |
| BLUE_PUB_REPORTS_OPTION_ITEM | Key, value pairs | 9 | Optional fields output, which are defined in the BPI report pathway. |
The order of the output parameters will always be returned in the order described by the table above.
For example, if a URL with the correct inputs is sent to the system, as follows:
https://example.exploranceblue.com/BPIEX/PathwayService.svc/GetUserReports?pathway=80&Cat=2017&userID=user10
A list of report objects with a set of corresponding output properties will be returned. Below is an example of a report object.
Back to top