APIs & services / commons-report-service

VO-wise nine-principles figures.

Endpointtoday's app

Call: GET /gateway/commons-report-service/api/v1/datasets/name/PlusOneCadreAnalytics9PrinciplesVOWise/execute
Service: commons-report-service
Features: Analytics dashboard
When: Periodic 12 h and on demand (UIC)
Auth: X-SESSIONID set by CoreAPI (dooNowOrThrow)
In the App Service: GET /analytics/dashboard

Use case

Nine-principles counts for the VOs a cadre filtered by. FetchAnalyticsDataWorker calls it in the cadre branch when VO ids are passed, after PlusOneCadreAnalyticsVOWiseSum, and stores the result in KEY_ANALYTICS_9_PRINCIPLE_DATA for OverallMisFragment. A failure stores an empty list.

Headers

Header	Value	Notes
`X-SESSIONID`	<session token>	Not set by the call site. AuthInterceptor (OkHttpClientInterceptor) adds it from AndroidSessionManager. On a 401 or 400 it invalidates the token, gets a fresh one and retries once.

Parameters

Param	In	Required	Example	Notes
`datasetName`	path	Yes	`PlusOneCadreAnalytics9PrinciplesVOWise`	Dataset name in the path of commons-report-service /api/v1/datasets/name/{name}/execute.
`version`	query	Yes	`1`	Dataset version. Always 1.
`format`	query	Yes	`json`	Response format. Always json, so the body is a JSON array of row objects.
`params`	query	Yes	`IN_PARAM_VO_CODE=VO-ALIAS-001`	Dataset input parameters as KEY=value pairs joined with "--". IN_PARAM_VO_CODE = comma-separated VO aliases selected in the dashboard filter.

Request

No body. VO params

Response

Example response body (synthetic data)

[
  {
    "CadreLogin": "9XXXXXXXX1",
    "PMDSKIT": 12,
    "S2SKIT": 8,
    "PMDS in Pelletisation Mode": 5,
    "100% Chemical Free Practices": 30,
    "Natural Growth Promoters": 22,
    "Beejamrutham": 40,
    "Ghanajeevamrutham": 35,
    "Dhravajeevamrutham": 33,
    "Botanical Extracts or Kasayams": 18
  }
]

Field	Type	Notes
`CadreLogin`	string	Cadre login (or VO for the VO-wise variant).
`PMDSKIT, S2SKIT`	number	Farmers who received PMDS / S2S kits.
`PMDS in Pelletisation Mode`	number	Key with spaces; mapped via @SerializedName.
`100% Chemical Free Practices, Natural Growth Promoters, Beejamrutham, Ghanajeevamrutham, Dhravajeevamrutham, Botanical Extracts or Kasayams`	number	Adoption counts for each natural-farming principle; shown in OverallMisFragment.

Errors

Status	When	What the app does
`401 / 400`	Session token expired or rejected	AuthInterceptor refreshes the token and retries once; if the retry also fails, Empty list stored.
`5xx`	Dataset query failed on the server	Empty list stored.
`network error`	No connectivity or timeout	Empty list stored.

Source

app/src/main/java/org/platformcommons/urvi/datasource/network/retrofit/APIInterface.kt
app/src/main/java/org/platformcommons/urvi/datasource/service/FetchAnalyticsDataWorker.kt
app/src/main/java/org/platformcommons/urvi/datasource/network/responsedto/Analytics9PrinciplesDto.kt