Geofences

Use these API endpoints to read locations/geofences.

Current version: 1

Example location

{
  "location": {
    "id": "Abc123",
    "name": "Name",
    "created_at": "2021-01-01T13:00:00.000+01:00",
    "updated_at": "2021-01-01T13:00:00.000+01:00",
    "geofence": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            6.16082320623836,
            52.2565655911962
          ],
          [
            6.16231927018295,
            52.2560913133295
          ],
          [
            6.16282925068063,
            52.2551083857491
          ],
          [
            6.16205446269097,
            52.2541926059109
          ],
          [
            6.16044880509453,
            52.2538804085077
          ],
          [
            6.1589527957219,
            52.2543546627341
          ],
          [
            6.15844273798648,
            52.2553375736115
          ],
          [
            6.15921747140418,
            52.25625337709
          ],
          [
            6.16082320623836,
            52.2565655911962
          ]
        ]
      ]
    }
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<location>
  <id>Abc123</id>
  <name>Name</name>
  <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
  <updated-at type="dateTime">2021-01-01T13:00:00+01:00</updated-at>
  <geofence>
    <type>Polygon</type>
    <coordinates type="array">
      <coordinate type="array">
        <coordinate type="array">
          <coordinate type="float">6.160823206238364</coordinate>
          <coordinate type="float">52.25656559119624</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.1623192701829534</coordinate>
          <coordinate type="float">52.256091313329506</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.16282925068063</coordinate>
          <coordinate type="float">52.255108385749075</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.16205446269097</coordinate>
          <coordinate type="float">52.25419260591091</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.160448805094526</coordinate>
          <coordinate type="float">52.2538804085077</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.158952795721897</coordinate>
          <coordinate type="float">52.254354662734094</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.158442737986484</coordinate>
          <coordinate type="float">52.25533757361153</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.159217471404184</coordinate>
          <coordinate type="float">52.25625337709004</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.160823206238364</coordinate>
          <coordinate type="float">52.25656559119624</coordinate>
        </coordinate>
      </coordinate>
    </coordinates>
  </geofence>
</location>

Index

Gets a list with all locations. This is a paginated response.

URL
GET https://my.iobee.eu/api/locations

Response

Status
200 - OK
Body
{
  "locations": [
    {
      "id": "Abc123",
      "name": "Name",
      "created_at": "2021-01-01T13:00:00.000+01:00",
      "updated_at": "2021-01-01T13:00:00.000+01:00",
      "geofence": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              6.16082320623836,
              52.2565655911962
            ],
            [
              6.16231927018295,
              52.2560913133295
            ],
            [
              6.16282925068063,
              52.2551083857491
            ],
            [
              6.16205446269097,
              52.2541926059109
            ],
            [
              6.16044880509453,
              52.2538804085077
            ],
            [
              6.1589527957219,
              52.2543546627341
            ],
            [
              6.15844273798648,
              52.2553375736115
            ],
            [
              6.15921747140418,
              52.25625337709
            ],
            [
              6.16082320623836,
              52.2565655911962
            ]
          ]
        ]
      }
    }
  ],
  "_next_page": {
    "token": "eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9",
    "empty": true,
    "remaining": 0,
    "url": "https://my.iobee.eu/docs/api/locations?page_token=eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9"
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<hash>
  <locations type="array">
    <location>
      <id>Abc123</id>
      <name>Name</name>
      <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
      <updated-at type="dateTime">2021-01-01T13:00:00+01:00</updated-at>
      <geofence>
        <type>Polygon</type>
        <coordinates type="array">
          <coordinate type="array">
            <coordinate type="array">
              <coordinate type="float">6.160823206238364</coordinate>
              <coordinate type="float">52.25656559119624</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.1623192701829534</coordinate>
              <coordinate type="float">52.256091313329506</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.16282925068063</coordinate>
              <coordinate type="float">52.255108385749075</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.16205446269097</coordinate>
              <coordinate type="float">52.25419260591091</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.160448805094526</coordinate>
              <coordinate type="float">52.2538804085077</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.158952795721897</coordinate>
              <coordinate type="float">52.254354662734094</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.158442737986484</coordinate>
              <coordinate type="float">52.25533757361153</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.159217471404184</coordinate>
              <coordinate type="float">52.25625337709004</coordinate>
            </coordinate>
            <coordinate type="array">
              <coordinate type="float">6.160823206238364</coordinate>
              <coordinate type="float">52.25656559119624</coordinate>
            </coordinate>
          </coordinate>
        </coordinates>
      </geofence>
    </location>
  </locations>
  <_next-page>
    <token>eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9</token>
    <empty type="boolean">true</empty>
    <remaining type="integer">0</remaining>
    <url>https://my.iobee.eu/docs/api/locations?page_token=eyJzIjoxNjA5NTAyNDAwLjAsImkiOm51bGx9</url>
  </_next-page>
</hash>

Show

Gets the specified location.

URL
GET https://my.iobee.eu/api/locations/:id

Response

Status
200 - OK
Body
{
  "location": {
    "id": "Abc123",
    "name": "Name",
    "created_at": "2021-01-01T13:00:00.000+01:00",
    "updated_at": "2021-01-01T13:00:00.000+01:00",
    "geofence": {
      "type": "Polygon",
      "coordinates": [
        [
          [
            6.16082320623836,
            52.2565655911962
          ],
          [
            6.16231927018295,
            52.2560913133295
          ],
          [
            6.16282925068063,
            52.2551083857491
          ],
          [
            6.16205446269097,
            52.2541926059109
          ],
          [
            6.16044880509453,
            52.2538804085077
          ],
          [
            6.1589527957219,
            52.2543546627341
          ],
          [
            6.15844273798648,
            52.2553375736115
          ],
          [
            6.15921747140418,
            52.25625337709
          ],
          [
            6.16082320623836,
            52.2565655911962
          ]
        ]
      ]
    }
  }
}
<?xml version="1.0" encoding="UTF-8"?>
<location>
  <id>Abc123</id>
  <name>Name</name>
  <created-at type="dateTime">2021-01-01T13:00:00+01:00</created-at>
  <updated-at type="dateTime">2021-01-01T13:00:00+01:00</updated-at>
  <geofence>
    <type>Polygon</type>
    <coordinates type="array">
      <coordinate type="array">
        <coordinate type="array">
          <coordinate type="float">6.160823206238364</coordinate>
          <coordinate type="float">52.25656559119624</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.1623192701829534</coordinate>
          <coordinate type="float">52.256091313329506</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.16282925068063</coordinate>
          <coordinate type="float">52.255108385749075</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.16205446269097</coordinate>
          <coordinate type="float">52.25419260591091</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.160448805094526</coordinate>
          <coordinate type="float">52.2538804085077</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.158952795721897</coordinate>
          <coordinate type="float">52.254354662734094</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.158442737986484</coordinate>
          <coordinate type="float">52.25533757361153</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.159217471404184</coordinate>
          <coordinate type="float">52.25625337709004</coordinate>
        </coordinate>
        <coordinate type="array">
          <coordinate type="float">6.160823206238364</coordinate>
          <coordinate type="float">52.25656559119624</coordinate>
        </coordinate>
      </coordinate>
    </coordinates>
  </geofence>
</location>