Home / Documentation / Mobile & Researcher API
Mobile & Researcher API

Tasks

A published guide from Survanta's public documentation.

Tasks

Overview

Field tasks are assignments for tenant users. A task may reference one survey, but the task does not grant survey access by itself; the centralized survey access policy calculates canStartSurvey.

Viewing Your Tasks

To see your assigned tasks:

  1. Sign in to the Survanta mobile app.
  2. Tap Tasks in the bottom navigation bar.
  3. Call GET /api/mobile/tasks to list tasks assigned to the current user.

Each task card shows:

  • Task title — a short name describing the assignment.
  • CompletionisDone and optional completedAt; the mobile contract does not expose Pending/In Progress states.
  • Task date and coordinatestaskDate, latitude, and longitude.
  • Linked survey — optional surveyId plus server-calculated canStartSurvey.

Task Statuses

Status Meaning
isDone=false The task is assigned and not completed.
isDone=true The task completion endpoint has succeeded.

Accepting a Task

The current mobile API does not expose task acceptance.

To begin work on a task:

  1. Tap the task to open its detail screen.
  2. Read the task description, instructions, and deadline carefully.
  3. If surveyId is present and canStartSurvey=true, load the survey runtime.
  4. There is no acceptance request or In-Progress transition to send.

Only tasks assigned to the current user are returned, and only that user can complete them through this route.

Working on a Task

While working on a task:

  • Open the linked survey by tapping Open Survey on the task detail screen.
  • Complete all required questions in the questionnaire.
  • Submit the survey when finished.

The task remains isDone=false until completion succeeds.

Marking a Task as Complete

To mark an assigned task complete:

  1. Return to the task detail screen.
  2. Tap Mark as Complete.
  3. Call POST /api/mobile/tasks/{id}/complete with an optional body containing completedLatitude, completedLongitude, and completedAccuracyMeters.

The task changes to isDone=true. The API does not remove it automatically; request isDone=false for active work or isDone=true for completed work.

Task Deadlines and Reminders

  • Each task has a due date set by your organization's administrator.
  • Reminder generation and visual overdue highlighting are not defined by the task API contract.
  • Clients can compare taskDate with their display rules but should not infer an undocumented server status.

Filtering and Searching Tasks

Use the filter controls at the top of the task list to:

  • Filter with fromDate, toDate, and isDone.
  • Supply optional page or pageSize; when either is present, results are ordered by taskDate then id, and page size is clamped to 100.
  • No text-search or arbitrary-sort parameter is exposed.

Notes for Tenant Users

  • You can only work on tasks explicitly assigned to your account.
  • If you believe a task was assigned to you in error, contact your organization's administrator rather than ignoring it.
  • Survey access and task completion are separate server operations; do not assume the client-side presence of a survey grants access or that the task API verifies a prior submission unless the server result confirms it.

Subscription requirement

Both the task list and task completion require an active organization subscription, and are refused with errorCode 1001 / code "SubscriptionExpired" while it is expired. A refused completion changes nothing: the task stays open, with no completion time and no actor recorded.

Assignment and organization boundaries are unaffected by subscription state — a collector who is not assigned a task is refused either way, and learns nothing about it.

See Mobile Offline Work and Operations.

Support

Please log in or create an account to chat with our support team.