Field Nation API Reference

Use a Saved Location

Refer to Get Locations to return a list of your saved location ids. You can also click MANAGE > Locations from the Field Nation Platform.

Parameter	Type	Example	Mapping/Notes
mode	string	“mode”: “location”	Required to send a saved Location.
saved_location	object	“saved_location”:{ “id”:16267 }	Saved Location id

Fixed Pay Examples

Create Work Order, Saved Location


"location":{  
   "mode":"location",
   "saved_location":{  
      "id":16267
   }
}

Update Work Order, Saved Location


{  
   "mode":"location",
   "saved_location":{  
      "id":16267
   }
}

Use a Custom Location

Use an unsaved address.

Parameter	Type	Example	Mapping/Notes
mode	string	“mode”: “custom”	Required to send a custom Location.
display_name	string	“display_name”:“ABC Corp”	Location > Location name. Optional.
address1	string	“address1”:“123 Main Street”	Location > Street Address.
address2	string	“address2”:“Building 4C”	Location > Address 2.
city	string	“city”:“Phoenix”	Location > City.
state	string	“state”:“AZ”	Location > State.
zip	string	“zip”:“85001”	Location > Zip.
country	string	“country”:“US”	Location > Country. Refer to Country Codes for a list of codes.
type	object	“type”:{ “id”:1 }	Location > Type. Optional. Options 1 = Commercial 2 = Governmental 3 = Residential 4 = Educational 5 = Other

Custom Location Examples

Create Work Order, Custom Location


"location":{  
   "mode":"custom",
   "display_name":"ABC Corp",
   "address1":"123 Main Street",
   "address2":"Building 4C",
   "city":"Phoenix",
   "state":"AZ",
   "zip":"85001",
   "country":"US",
   "type":{  
      "id":1
   }
}

Update Work Order, Custom Location


{  
   "mode":"custom",
   "display_name":"ABC Corp",
   "address1":"123 Main Street",
   "address2":"Building 4C",
   "city":"Phoenix",
   "state":"AZ",
   "zip":"85001",
   "country":"US",
   "type":{  
      "id":1
   }
}

Use a Remote Location

This work order is for a remote provider and does not have a location.

Parameter	Type	Example	Mapping/Notes
mode	string	“mode”: “remote”	Required to send a remote Location.

Remote Location Examples

Create Work Order, Remote Location


"location":{  
   "mode":"remote"
}

Update Work Order, Remote Location


{  
   "mode":"remote"
}

Work Order Location Response

You can locate work order location information in the work order > location object.

"location": { }

Work order location responses will vary depending on the location mode. The work order saved location response includes notes, location contact, location group, and location attributes.

Work Order Location Response, Saved Location

The work order saved location response includes public notes (if applicable) and populates the saved_location object.


“location”:{
   “coordinates”:{
      “latitude”:33.44860076904297,
      “longitude”:-112.072998046875,
      “exact”:false
   },
   “work_order_id”:1731,
   “mode”:“location”,
   “address1”:“123 Main Street”,
   “address2”:“Building 4C”,
   “city”:“Phoenix”,
   “state”:“AZ”,
   “zip”:“85001”,
   “country”:“US”,
   “notes”:[
      {
         “id”:0,
         “text”:“note 1”,
         “private”:false,
         “created”:false,
         “user”:0
      }
   ],
   “type”:{
      “id”:1,
      “name”:“Commercial”
   },
   “saved_location”:{
      “id”:16325,
      “name”:“New Saved Location”,
      “display_name”:“ABC Corp”,
      “contact”:{
         “name”:“Office Manager”,
         “phone”:“+14805551234”
      },
      “group”:{
         “id”:52,
         “name”:“AZ Locations”
      }
   },
   “display_name”:“ABC Corp”,
   “status_id”:1,
   “correlation_id”:“909c14b49aac6cfee491f98dbe4ff8ac3293dbe2”,
   “zoom”:“13z”,
   “map”:{
      “url”:“https://maps.tilehosting.com/styles/streets/static/-112.072998,33.448601,13/320x300@2x.png?key=RZydBF85bkJ7CsJrAl6B&attribution=0&markers=-112.07299804688,33.448600769043",
      “href”:“https://www.google.com/maps/search/123+Main+Street+Phoenix+AZ+85001/@33.448600769043,-112.07299804688,13z"
   },
   “actions”:[
      “edit”,
      “can_edit_country”,
      “map”
   ]
}

Work Order Location Response, Custom Location


"location":{
   "coordinates":{
      "latitude":33.44860076904297,
      "longitude":-112.072998046875,
      "exact":false
   },
   "work_order_id":3457,
   "mode":"custom",
   "address1":"123 Main Street",
   "address2":"Building 4C",
   "city":"Phoenix",
   "state":"AZ",
   "zip":"85001",
   "country":"US",
   "notes":[

   ],
   "type":{
      "id":1,
      "name":"Commercial"
   },
   "saved_location":{
      "id":0,
      "name":"",
      "display_name":"",
      "contact":{
         "name":"",
         "phone":""
      },
      "group":{
         "id":0,
         "name":""
      }
   },
   "display_name":"ABC Corp",
   "status_id":1,
   "correlation_id":"1e7886ae1f2dbacf175645aa73ea68195f801e2b",
   "zoom":"13z",
   "map":{
      "url":"https://maps.tilehosting.com/styles/streets/static/-112.072998,33.448601,13/320x300@2x.png?key=RZydBF85bkJ7CsJrAl6B&attribution=0&markers=-112.07299804688,33.448600769043",
      "href":"https://www.google.com/maps/search/123+Main+Street+Phoenix+AZ+85001/@33.448600769043,-112.07299804688,13z"
   },
   "actions":[
      "edit",
      "can_edit_country",
      "map"
   ]
}

Work Order Location Response, Remote Location


"location":{
   "coordinates":{
      "latitude":0,
      "longitude":0,
      "exact":false
   },
   "work_order_id":1729,
   "mode":"remote",
   "address1":"",
   "address2":"",
   "city":"",
   "state":"",
   "zip":"",
   "country":"US",
   "notes":[

   ],
   "type":{
      "id":1,
      "name":"Commercial"
   },
   "saved_location":{
      "id":0,
      "name":"",
      "display_name":"",
      "contact":{
         "name":"",
         "phone":""
      },
      "group":{
         "id":0,
         "name":""
      }
   },
   "display_name":"",
   "status_id":1,
   "correlation_id":"59c041c7374401634f273aab6ed91b63c27fa89d",
   "zoom":"13z",
   "map":{
      "url":"",
      "href":""
   },
   "actions":[
      "edit",
      "can_edit_country"
   ]
}