APIs & services / commons-report-service

List districts. Same call duplicated in three client classes.

Endpointtoday's app

Call: GET /gateway/commons-report-service/api/v1/datasets/name/PlusOneGetAllDistricts/execute
Service: commons-report-service
Features: VO geographic filter (FCCC), Leased land
When: User drills down a geography filter
Auth: X-SESSIONID set by CoreAPI (dooNowOrThrow)
In the App Service: GET /geo/children

Use case

First level of the geography drill-down. EndorsementFragment uses it (via EndorsementRepositoryImpl) for the VO endorsement geo filter, and AddUpdateAssetNewDialog uses it (via VoFilterRepoImpl) to find the other farmer in a land lease. Results fill the district dropdown; errors leave it empty.

Headers

Header	Value	Notes
`X-SESSIONID`	<session token>	Added by Bridge CoreAPI from the AccountManager session when the Operation is executed with dooNowOrThrow. The app code does not set it.

Parameters

Param	In	Required	Example	Notes
`datasetName`	path	Yes	`PlusOneGetAllDistricts`	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	No		Not sent; the dataset takes no input.

Request

No body.

Response

Example response body (synthetic data)

[
  {
    "DistrictAlias": "D01",
    "DistrictNames": "District A"
  },
  {
    "DistrictAlias": "D02",
    "DistrictNames": "District B"
  }
]

Field	Type	Required	Notes
`DistrictAlias`	string		District code; dropdown value and DISTRICT_ALIAS for the mandal call.
`DistrictNames`	string		Label shown in the district dropdown.

Errors

Status	When	What the app does
`non-2xx`	Server rejects the call or the dataset query fails (CoreAPI handles session refresh internally)	Resource.error with the raw response; the dropdown stays empty. In EndorsementRepositoryImpl the call runs without try/catch, so a thrown exception is not caught there. VoFilterRepoImpl catches it and shows "Something went wrong".
`network error`	No connectivity or timeout	Resource.error with the raw response; the dropdown stays empty. In EndorsementRepositoryImpl the call runs without try/catch, so a thrown exception is not caught there. VoFilterRepoImpl catches it and shows "Something went wrong".

Source

app/src/main/java/org/platformcommons/urvi/datasource/repository/impl/EndorsementRepositoryImpl.kt
app/src/main/java/org/platformcommons/urvi/datasource/repository/impl/VoFilterRepoImpl.kt
app/src/main/java/org/platformcommons/urvi/view/endorsements/vo/EndorsementFragment.kt
app/src/main/java/org/platformcommons/urvi/view/landasset/AddUpdateAssetNewDialog.kt
app/src/main/java/org/platformcommons/urvi/view/landasset/LandAssetViewModel.kt
data/src/main/java/org/mindtree/app/agricultor/data/entity/voFilters/District.kt