APIs & services / Reporting datasets (rtld)

Load Unit In-charge details for the analytics dashboard filter.

Endpointtoday's app

Call: GET /rtld/api/dataset/v1/execute?name=PlusOneUnitInchargeInfo
Service: Reporting datasets (rtld)
Features: Analytics dashboard
When: Analytics dashboard filter
Auth: X-SESSIONID set by CoreAPI (dooNowOrThrow)
In the App Service: GET /session/bootstrap

Use case

Lists the cadres (and their VOs) under a Unit In-charge. DashboardFragment.GetCadareData calls it via IeViewModel/IeRepositoryImpl.getCadreData when the analytics filter bottom sheet opens. The list is cached in SharedPreferences CADRE_DATA and fills the cadre/VO filter. Note: endpoints.json says "profile / farmer screens", but the only live caller is the dashboard filter. On error the filter keeps its progress state and nothing is cached.

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
`name`	query	Yes	`PlusOneUnitInchargeInfo`	Dataset name. The rtld executor (/rtld/api/dataset/v1/execute) picks the dataset by this query param.
`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	`UNIT=9XXXXXXXX1`	Dataset input parameters as KEY=value pairs joined with "--". UNIT = user login before "@@" and before the first "-" (the Unit In-charge login).

Request

No body. cadre params

Response

Example response body (synthetic data)

[
  {
    "VOCode": "VO-ALIAS-001",
    "VOName": "VO A",
    "Unit": "Unit A",
    "Village": "Village A",
    "Habitation": "Habitation A",
    "Unit Incharge": "Unit In-charge A",
    "Final Unit Incharge": "Unit In-charge A",
    "ICRP Name/Responsible Person Name": "Cadre A",
    "CadreLogin": 1000000001
  }
]

Field	Type	Notes
`VOCode, VOName`	string	VO options in the analytics filter; VOCode is passed as IN_PARAM_VO_CODE to the VO-wise analytics.
`ICRP Name/Responsible Person Name`	string	Cadre name shown in the filter (@SerializedName with spaces).
`CadreLogin`	long	Cadre login id for the row.
`Unit, Village, Habitation, Unit Incharge, Final Unit Incharge`	string	Cached with the rest; shown in or used by the filter list.

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, Resource.error; filter list not refreshed. An exception on the executor thread is not caught.
`5xx`	Dataset query failed on the server	Resource.error; filter list not refreshed. An exception on the executor thread is not caught.
`network error`	No connectivity or timeout	Resource.error; filter list not refreshed. An exception on the executor thread is not caught.

Source

app/src/main/java/org/platformcommons/urvi/datasource/network/retrofit/APIInterface.kt
app/src/main/java/org/platformcommons/urvi/datasource/repository/impl/IeRepositoryImpl.kt
app/src/main/java/org/platformcommons/urvi/view/ie/IeViewModel.kt
app/src/main/java/org/platformcommons/urvi/view/dashboard/DashboardFragment.kt
app/src/main/java/org/platformcommons/urvi/datasource/network/responsedto/CadareDta.kt