API contracts / App Service v2 / Farmers

Search farmers in a geography (online)

OperationsearchFarmers
Call
GET /gateway/urvi-app-service/api/v2/farmers/search
Group
Farmers
Features
Leased land, VO geographic filter (FCCC), Farmer endorsement details, VO / SHG / Farmer endorsement
Replaces today

Use case. Called online by the leased-land lessor picker (farmers of an SHG, or non-SHG farmers of a VO), the FCCC habitation filter and the endorsement farmer lists (with kapSubmitted for bulk endorse). Read-only: never wipes or replaces local data (the FCCC flow stores results in a separate cache).

Rules.

  • geo must be inside the user's work nodes or, for FCCC users, inside the tenant.
  • q all digits starting 6-9 searches mobile numbers; otherwise names (prefix matches first).

Error codes. ROLE_NOT_ALLOWED

Parameters

NameInTypeRequiredMeaningExample
X-App-VersionheaderstringYesApp version `major.minor.patch+build`. Too old -> 426 `VERSION_TOO_OLD`. · pattern ^\d+\.\d+\.\d+(\+\d+)?$2.0.0+200
X-Device-Idheaderstring (uuid)YesApp-scoped device UUID (not ANDROID_ID).6b1f2c3d-0000-4000-8000-00000000d001
X-Request-Idheaderstring (uuid)NoClient-generated request id for tracing; echoed in responses and problems.0e0c5a1b-0000-4000-8000-0000000000a1
Accept-LanguageheaderstringNoLanguage for messages and labels. · one of en, te, ta; default "en"te
X-TenantheaderstringNoTenant code; must match the token. Urvi: `ap.gov`. · one of ap.govap.gov
geoquerystringYesGeography node: `shg:<id>`, `vo:<id>`, `vo:<id>:non-shg` or `habitation:<id>`. · pattern ^(shg|vo|habitation):\d+(:non-shg)?$shg:52001
qquerystringNoName or mobile prefix. · max length 100Farmer
excludeFarmerIdqueryinteger (int64)NoExclude this farmer (the lessee).700002
cursorquerystringNoOpaque cursor from the previous page. · max length 512eyJwIjoyfQ
pageSizequeryintegerNoItems per page. · ≥ 1; ≤ 500; default 100100

Request

No body.

Responses

200 Matching farmers.

Schema FarmerSearchPage.

Example 200 body
{
  "items": [
    {
      "id": 700001,
      "clientId": "3f6c1a2e-0000-4000-8000-000000061441",
      "ieId": "IE-AP-0000001",
      "name": "Farmer A",
      "relativeName": "Spouse A",
      "gender": "FEMALE",
      "shg": {
        "id": 52001,
        "type": "SHG",
        "name": "SHG A",
        "code": "SHG-52001"
      },
      "vo": {
        "id": 4101,
        "type": "VO",
        "name": "VO A",
        "code": "VO-4101"
      },
      "category": "FARMER",
      "lifeStatus": "ACTIVE",
      "kapSubmitted": true,
      "endorsementStatus": "PENDING"
    }
  ],
  "page": {
    "nextCursor": null,
    "hasMore": false,
    "pageSize": 100
  }
}
FieldTypeRequiredRulesMeaning
itemsFarmerSummary[]Yes
pagePageInfoYes

400 Malformed request or schema violation.

Schema Problem.

Example 400 body
{
  "type": "https://urvi.example.invalid/problems/validation-failed",
  "title": "Validation failed",
  "status": 400,
  "detail": "One or more fields are invalid.",
  "code": "VALIDATION_FAILED",
  "requestId": "0e0c5a1b-0000-4000-8000-0000000000a1",
  "errors": [
    {
      "field": "/mobile",
      "code": "INVALID_MOBILE",
      "message": "Mobile must be 10 digits starting 6-9."
    }
  ]
}

401 Missing, invalid or expired access token. Refresh once, then ask the user to log in; pending outbox ops stay intact.

Schema Problem.

Example 401 body
{
  "type": "https://urvi.example.invalid/problems/token-expired",
  "title": "Session expired",
  "status": 401,
  "detail": "The access token has expired.",
  "code": "TOKEN_EXPIRED",
  "requestId": "0e0c5a1b-0000-4000-8000-0000000000a1"
}

403 Authenticated but not allowed (role, tenant, device binding or feature switch).

Schema Problem.

Example 403 body
{
  "type": "https://urvi.example.invalid/problems/role-not-allowed",
  "title": "Not allowed",
  "status": 403,
  "detail": "Your role cannot perform this action.",
  "code": "ROLE_NOT_ALLOWED",
  "requestId": "0e0c5a1b-0000-4000-8000-0000000000a1"
}

426 App version below the minimum; block the UI with an update prompt. Pending outbox ops are kept.

Schema Problem.

Example 426 body
{
  "type": "https://urvi.example.invalid/problems/version-too-old",
  "title": "Update required",
  "status": 426,
  "detail": "Please update Urvi to continue.",
  "code": "VERSION_TOO_OLD",
  "requestId": "0e0c5a1b-0000-4000-8000-0000000000a1",
  "minAppVersion": "2.0.0"
}

429 Rate limited per device / user. Respect `Retry-After`.

Schema Problem.

Example 429 body
{
  "type": "https://urvi.example.invalid/problems/rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "Slow down and retry later.",
  "code": "RATE_LIMITED",
  "requestId": "0e0c5a1b-0000-4000-8000-0000000000a1",
  "retryAfterSeconds": 30
}

500 Unexpected server error; retry with backoff (writes are idempotent).

Schema Problem.

Example 500 body
{
  "type": "https://urvi.example.invalid/problems/internal-error",
  "title": "Server error",
  "status": 500,
  "detail": "Something went wrong. Please try again.",
  "code": "INTERNAL_ERROR",
  "requestId": "0e0c5a1b-0000-4000-8000-0000000000a1"
}