API contracts / App Service v2 / Geography

Children of a geography node

OperationgetGeoChildren
Call
GET /gateway/urvi-app-service/api/v2/geo/children
Group
Geography
Features
Leased land, VO geographic filter (FCCC), Farmer endorsement details, Village, Habitation and VO selection
Replaces today

Use case. Called online by cascading geography pickers: the leased-land lessor search (District > Mandal > Village > VO > Habitation > SHG), the FCCC VO filter and the endorsement location filter. With no parent returns the districts of the tenant. Cached server-side; the app caches per parent for the session.

Rules.

  • level must be the child level of parent (e.g. parent VO -> HABITATION).
  • SHG lists start with the synthetic Non-SHG entry (id 0).

Error codes. NOT_FOUND

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
levelqueryGeoNodeTypeYesLevel of the children requested. · one of STATE, DISTRICT, MANDAL, VILLAGE, PANCHAYAT, VO, HABITATION, SHGHABITATION
parentqueryinteger (int64)NoParent node id; omit for districts.4101

Request

No body.

Responses

200 Children.

Schema GeoChildrenResponse.

Example 200 body
{
  "parent": {
    "id": 4101,
    "type": "VO",
    "name": "VO A",
    "code": "VO-4101"
  },
  "level": "HABITATION",
  "items": [
    {
      "id": 3901,
      "code": "HAB-3901",
      "type": "HABITATION",
      "name": {
        "en": "Habitation A",
        "te": "Habitation A (te)"
      },
      "parentId": 4101
    }
  ]
}
FieldTypeRequiredRulesMeaning
parentGeoRefNoLightweight reference to a geography / work node.
levelGeoNodeTypeYesone of STATE, DISTRICT, MANDAL, VILLAGE, PANCHAYAT, VO, HABITATION, SHG
itemsGeoNode[]Yes

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"
}

404 Resource not found or outside the user's work nodes.

Schema Problem.

Example 404 body
{
  "type": "https://urvi.example.invalid/problems/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "No such resource in your work area.",
  "code": "NOT_FOUND",
  "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"
}