Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
curl -X GET \
  https://bluzone.io/portal/papis/v1/projects/<YOUR_PROJECT_ID_HERE>/devices/beacons/<BEACON_ID_HERE> \
  -H 'bzid: <YOUR_API_KEY_HERE>'

...

API Examples

Most Bluzone APIs follow restful patterns.  Business use cases often require simplified APIs to perform repetitive and high value tasks.  The best solution for these business needs is not always the most "RESTful" pattern.  When Bluzone APIs break out of a true "RESTful" pattern, the API becomes more task oriented and begins with an underscore.  This section will use three common APIs as examples of this "RPC" type pattern in Bluzone APIs.

...

```json
{
"projectName": "New Name Value"
}
```

API Details

MethodPUT
URI/portal/papis/v1/projects/{{projectId}}/_rename
Acceptapplication/json
ResponseProject.json

Beacon Rename

Rename a Beacon in context with the newly supplied name.

...

```json
{
"beaconName": "New Name Value"
}
```

API Details

MethodPUT
URI/portal/papis/v1/projects/{{projectId}}/devices/beacons/{{beacon.deviceId}}/_rename
Acceptapplication/json
ResponseBeacon.json

Blufi Rename

Rename a Blufi in context with the newly supplied name.

...

```json
{
"blufiName": "New Name Value"
}
```

API Details

MethodPUT
URI/portal/papis/v1/projects/{{projectId}}/devices/blufis/{{blufi.deviceId}}/_rename
Acceptapplication/json
ResponseBlufi.json