Skip to content

REST API

James Stine edited this page Aug 31, 2019 · 1 revision

Here are the valid REST API endpoints along with any example payloads.

Place Waymarks

Allows to place waymarks at specific coordinates. Waymarks are specified with the keys A, B, C, D, One and Two. You may specify X, Y and Z coordinates, as well as an Active state which is true|false. Note: If you want to simply hide a waymark, you only need to specify that Active is set to false, no coordinates are needed.

Endpoint: /place

Payload:

{
  "A": { "X": 5.0, "Y": 0.0, "Z": 3.0", "Active", true },
  "B": { "X": 5.0, "Y": 0.0, "Z": 3.0", "Active", true },
  "One": { "Active", false },
}

Save Preset

Save the current waymarks as a new preset. Simply specify the name of the preset in the URL.

Endpoint: /preset/{name}/save

Load Preset

Loads a given preset by name. Simply specify the name of the preset in the URL.

Endpoint: /preset/{name}/load

You can’t perform that action at this time.