Location API Retrieve, Create and Update Locations

This guide documents the two Location endpoints:

• get_locations export the current list from Microkeeper
• upsert_locations insert new locations or update existing ones

Retrieving Locations (get_locations)

The get_locations call returns all locations (active and inactive) that belong to the authenticated business.

{ "status":"all" }

Response

{
  "success":"1",
  "authenticated":"1",
  "message":"Location data",
  "data":{"locations":[{  rows as above  }]}
}

Creating & Updating Locations (upsert_locations)

upsert_locations inserts new locations or updates existing ones.

Any location sent is up-inserted; locations that are not sent remain unchanged.

• Each locations[] object must include title, active, and either LID (set to 0 to insert) or third_ID.
• LID = 0 or an unknown third_ID > new location (auto-increment id).
• Unknown non-zero LID aborts the call with "LID x does not exist".
• manager_eusername is an array.

{
  "config": { "write_list": "all" },
  "locations": [
    {
      "LID"              : "0",
      "third_ID"         : "EXT-LOC-A",
      "title"            : "Brisbane Depot",
      "lon"              : "153.025131",
      "lat"              : "-27.469770",
      "manager_eusername": ["alice_long","frank_fulltime","john_smith"],
      "GID"              : "269",
      "CID"              : "4",
      "hours_goal"       : "100.00",
      "cost_goal"        : "10000.00",
      "color"            : "#FF80EA",
      "active"           : "1"
    },
    {
      "LID"    : "1234",
      "title"  : "Melbourne HQ",
      "active" : "0"
    }
  ]
}

mk_data variables

config object

locations[] field reference

Successful Response

{
  "success":"1",
  "authenticated":"1",
  "message":"Locations updated",
  "data":{"LID":[1234,1235]}
}