APIs & services / commons-report-service

Download the flattened farmer list, page by page (resumable).

Endpointtoday's app

Call: GET /gateway/commons-report-service/api/v1/datasets/name/PlusOneWorkNodeFarmerListGeoWise/execute
Service: commons-report-service
Features: Data download (Cadre), Farmer list & search
When: Data download (cadre)
Auth: X-SESSIONID header (AuthInterceptor adds it; re-auth on 401/400)
In the App Service: GET /farmers/snapshot

Use case

Called once per page after the count call in the cadre Data Setup flow (DataSetupViewModel). Each page of flat farmer rows is cleaned (empty SHG -> NON_SHG, "?" -> "-" in category, relative surname merged) and inserted into ie_flat_entity, which powers the farmer list and hub. The current page is saved after each page, so a failure throws, marks the download failed and the next attempt resumes from that page.

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	`PlusOneWorkNodeFarmerListGeoWise`	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	`WORK_NODE_HABITATION_ALIAS=H01--WORK_NODE_VO_ALIAS=VO-ALIAS-001--WORK_NODE_VILLAGE_ALIAS=V01--LIMIT_OFFSET=250--LIMIT_ROW_COUNT=250`	Dataset input parameters as KEY=value pairs joined with "--". Same three geography aliases as the count call, plus LIMIT_OFFSET = pageNo x page size (row offset) and LIMIT_ROW_COUNT = page size (ref data value or 250).

Request

No body. geo aliases + LIMIT_OFFSET, LIMIT_ROW_COUNT (default 250)

Response

Example response body (synthetic data)

[
  {
    "IEOLTPId": "100001",
    "uuid": "3f2a9c1e-0000-4000-8000-000000000001",
    "Member_ID": "M-000001",
    "Member_Name": "Farmer A",
    "Member_Surname": "Surname A",
    "Husband_father_Name": "Relative A",
    "Husband_father_Name_Surname": "Surname A",
    "member_phno": "9XXXXXXXX1",
    "Aadhar_no": "XXXX-XXXX-1234",
    "Member_gender": "GENDER.FEMALE",
    "Member_Age": "42",
    "DOB": "1983-01-01",
    "Maritual_status": "Married",
    "maritalStatusCode": "MARITAL_STATUS.MARRIED",
    "relationshipCode": "RELATIONSHIP.HUSBAND",
    "Educational_Qualification": "Primary",
    "educationalQualificationCode": "EDUCATION.PRIMARY",
    "Ration_card_number": "RC-XXXX-0001",
    "Category_ID": "11",
    "Category_Name": "Farmer/C1",
    "categoryCode": "CATEGORY.C1",
    "wellbeing_code": "WB.POOR",
    "District_code": "D01",
    "District_name": "District A",
    "DistrictOLTPId": "501",
    "Mandal_code": "M01",
    "Mandal_Name": "Mandal A",
    "MandalOLTPId": "601",
    "Panchayat_code": "P01",
    "Panchayat_Name": "Panchayat A",
    "PanchayatOLTPId": "701",
    "Village_code": "V01",
    "Village_name": "Village A",
    "VillageOLTPId": "801",
    "Village_Phase": "Phase 1",
    "Habitation_code": "H01",
    "Habitation_name": "Habitation A",
    "HabitationOLTPId": "901",
    "VO_id": "VO-ALIAS-001",
    "VO_Name": "VO A",
    "VOOLTPId": "1001",
    "VO_Formation_date": "2010-04-01",
    "SHG_ID": "SHG-ALIAS-001",
    "SHG_Name": "SHG A",
    "SHGOLTPId": "1101",
    "SHG_Registration_Date": "2011-06-01",
    "Member_Reg_Date": "2012-01-15",
    "IS_Active_": "Y",
    "IS_disabled": "N",
    "REMARK": null,
    "id": 1,
    "lifeStatus": "LIFE_STATUS.ALIVE",
    "inActiveReason": null
  }
]

Field	Type	Notes
`IEOLTPId`	string	Server IE (farmer) id. Stored as ie_flat_entity.iEOLTPId; used as the IEID in later dataset calls.
`uuid`	string	Farmer UUID; unique key of ie_flat_entity.uuid.
`Member_ID`	string	SERP member id; ie_flat_entity.memberID.
`Member_Name / Member_Surname`	string	Farmer name shown in lists and the farmer hub.
`Husband_father_Name / Husband_father_Name_Surname`	string	Relative name. The app concatenates surname into husbandFatherName and blanks the surname column.
`member_phno`	string	Phone number column.
`Aadhar_no`	string	Aadhaar column (masked in docs).
`Member_gender, Member_Age, DOB, Maritual_status, maritalStatusCode, relationshipCode, Educational_Qualification, educationalQualificationCode, Ration_card_number, wellbeing_code`	string	Profile columns stored as-is in ie_flat_entity and used by the IE profile screens.
`Category_ID / Category_Name / categoryCode`	string	Member category. "?" in Category_Name is replaced with "-" before saving; the part after "/" is the farmer category.
`District_* / Mandal_* / Panchayat_* / Village_* / Habitation_* (code, name, OLTPId)`	string	Geography columns used for filters and display.
`VO_id / VO_Name / VOOLTPId / VO_Formation_date`	string	Village organisation columns; VO_id drives VO filters and analytics.
`SHG_ID / SHG_Name / SHGOLTPId / SHG_Registration_Date`	string	SHG columns. Empty SHG_Name is replaced with the NON_SHG constant.
`Member_Reg_Date, Village_Phase, IS_Active_, IS_disabled, REMARK, id, lifeStatus, inActiveReason`	string\|int	Stored as-is; lifeStatus decides whether the farmer counts as active.

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, Throws "Failed to fetch farmer data at page N"; saved progress lets the user retry from that page.
`5xx`	Dataset query failed on the server	Throws "Failed to fetch farmer data at page N"; saved progress lets the user retry from that page.
`network error`	No connectivity or timeout	Throws "Failed to fetch farmer data at page N"; saved progress lets the user retry from that page.

Source

data/src/main/java/org/mindtree/app/agricultor/data/setup_new/SetupServiceNew.kt
app/src/main/java/org/platformcommons/urvi/view/datasetup/DataSetupViewModel.kt
data/src/main/java/org/mindtree/app/agricultor/data/entity/IEFlatEntity.kt