API contracts / App Service v2 / Files

File metadata and signed download URL

OperationgetFile
Call
GET /gateway/urvi-app-service/api/v2/files/{fileId}
Group
Files
Features
Geofencing, Land assets, Crop Actual (portfolio), ATM model (Anytime Money plot), VO / SHG / Farmer endorsement

Use case. Called when the app needs a file it does not have locally: the KML of a server geofence before editing it, a crop / ATM photo after reinstall, or an endorsed abstract. Returns a short-lived signed URL; the app downloads it directly.

Rules.

  • Only files of entities in the user's scope.

Error codes. FILE_NOT_FOUND, FILE_NOT_COMPLETE

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
fileIdpathstring (uuid)YesFile id from `POST /files`.7a6b5c4d-0000-4000-8000-0000000000e1

Request

No body.

Responses

200 File info.

Schema FileInfo.

Example 200 body
{
  "fileId": "7a6b5c4d-0000-4000-8000-000000000225",
  "kind": "KML_GEOFENCE",
  "mimeType": "application/vnd.google-earth.kml+xml",
  "sizeBytes": 2048,
  "sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "status": "COMPLETE",
  "url": "https://files.example.invalid/urvi/signed/land-1001.kml",
  "urlExpiresAt": "2025-10-14T10:30:00+05:30",
  "createdAt": "2025-10-14T09:30:00+05:30"
}
FieldTypeRequiredRulesMeaning
fileIdstring (uuid)Yes
kindFileKindYesone of PHOTO_FARMER, PHOTO_CROP, PHOTO_ATM, PHOTO_HARVEST, PHOTO_ACTIVITY, KML_GEOFENCE, SIGNATURE, ENDORSEMENT_ABSTRACT, ASSESSMENT_ATTACHMENT, DIAGNOSTICS
mimeTypestringNo
sizeBytesintegerNo≥ 1
sha256stringNo
statusstringYesone of PENDING, COMPLETE
urlstring (uri)NoSigned download URL (short-lived).
urlExpiresAtstring (date-time)No
createdAtstring (date-time)No

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