Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuick StartAPI Playground

Getting Started

API Reference

Overview
ScheduleShipmentsBundlesRevisits
Work OrdersLogistics

Revisits

Manage return visits when work requires multiple trips.


Revisits

When an incident or incomplete status requires the provider to return, a Revisit is created.

List Revisits

GET /workorders/{id}/site-revisits

Response

{
  "results": [
    {
      "id": 301,
      "reason": {
        "id": 10,
        "name": "Parts not delivered"
      },
      "notes": "Returning with correct router model",
      "scheduled": { "utc": "2024-01-17 09:00:00" },
      "status": "scheduled",
      "created": { "utc": "2024-01-15 16:00:00" }
    }
  ],
  "count": 1
}

Create Revisit

POST /workorders/{id}/site-revisits

{
  "revisit_reason_id": 10,
  "notes": "Returning with correct parts.",
  "scheduled": { "utc": "2024-01-17 09:00:00" }
}

Revisit Reasons

Get available revisit reasons for your company:

GET /company/{company_id}/reasons/revisit

{
  "results": [
    { "id": 10, "name": "Parts not delivered" },
    { "id": 11, "name": "Customer requested callback" },
    { "id": 12, "name": "Scope change" },
    { "id": 13, "name": "Site not ready" }
  ]
}

Incidents

An Incident flags that something went wrong (e.g., "Equipment failure"). It is often the reason why a revisit is needed.

Set Incident

PUT /workorders/{id}/incident

{
  "incident_id": 12
}

Job Status

Track the current state of work:

GET /workorders/{id}/job-status

{
  "status": "incomplete",
  "reason": "Parts missing",
  "revisit_scheduled": true
}

Revisit Flow

Loading diagram...

Revisits extend the work order lifecycle. Pay may be adjusted based on revisit circumstances.

Related

  • Schedule - Scheduling return visits
  • Compliance - Problems and issues

Last updated on

Bundles

Group multiple work orders for a single provider.

Users

Retrieve user details and profiles.

On this page

Revisits
List Revisits
Response
Create Revisit
Revisit Reasons
Incidents
Set Incident
Job Status
Revisit Flow
Related