Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuick StartAPI Playground

Getting Started

API Reference

Overview
LifecycleAssignmentsProvider ActionsSmart Dispatch
Work OrdersWorkflow

Assignments

Managing provider assignments, requests, and counter-offers.


Assignments

When you are ready to commit to a provider, you Assign them. This is the contract step.

Binding Contract: Assigning a provider creates a financial obligation (funds are held or verified) and a legal agreement to perform the work.

Strategies

  • Direct Assignment: You know the provider (user_id).
  • From Request: You routed the work, and are accepting a provider's application.

Assignment Flow

Loading diagram...

Assign a Provider

POST /workorders/{id}/assignee?clientPayTermsAccepted=true

{
  "user": { "id": 12345 }
}

Assignment Response

{
  "id": 1001,
  "status": "Assigned",
  "assignee": {
    "id": 12345,
    "first_name": "John",
    "last_name": "Smith",
    "rating": 4.8
  }
}

Unassign a Provider

Remove the current provider from the work order.

DELETE /workorders/{id}/assignee

Unassigning after the provider has started work may require providing a reason and could affect your company's metrics.

Provider Requests

When you route a work order, providers can Request it. You can view and manage these requests.

List Requests

GET /workorders/{id}/requests

{
  "results": [
    {
      "id": 501,
      "user": { "id": 12345, "name": "John Smith" },
      "status": "pending",
      "counter_offer": null,
      "created": { "utc": "2024-01-15 10:00:00" }
    }
  ]
}

Accept a Request

POST /workorders/{id}/requests/{request_id}/accept

Deny a Request

DELETE /workorders/{id}/requests/{request_id}

Counter-Offers

Providers can submit a counter-offer with different pay terms.

{
  "id": 501,
  "user": { "id": 12345 },
  "counter_offer": {
    "pay": {
      "type": "fixed",
      "base": { "amount": 175.00 }
    },
    "note": "Travel distance is significant"
  }
}

POST /workorders/{id}/requests/{request_id}/accept

Accepting a counter-offer assigns the provider at their requested rate.

DELETE /workorders/{id}/requests/{request_id}

You can reject and continue routing to other providers.

Assignment History

View all past assignments for a work order.

GET /workorders/{id}/assignments

{
  "results": [
    {
      "id": 1,
      "user": { "id": 12345, "name": "John Smith" },
      "status": "completed",
      "assigned_at": { "utc": "2024-01-15 10:00:00" }
    }
  ]
}

Related

  • Workflow Lifecycle - Full state management
  • Providers - Finding providers

Last updated on

Lifecycle

Publish, Route, Assign, and complete work orders.

Provider Actions

Handle provider-initiated actions like cancellations and delays.

On this page

Assignments
Strategies
Assignment Flow
Assign a Provider
Assignment Response
Unassign a Provider
Provider Requests
List Requests
Accept a Request
Deny a Request
Counter-Offers
Assignment History
Related