Get location of a specific client
GET {{base_url}}/visualrf_api/v1/client_location/:macaddr?offset=0&limit=100&units=FEET
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
offset | number | used as a page number when working with paginated results, with the first page being at offset 0 and last page at Math.ceil(total_items/limit)-1. |
For example: Assuming you have a collection of 100 items, and you want to retrieve them in batches of 20 items per page. Here's how you can use limit and offset in your API request:
Example 1: Retrieve the first page of items API Request: GET with limit=20&offset=0 API Response: Returns the first 20 items in the collection.
Example 2: Retrieve the second page of items API Request: GET with limit=20&offset=1 API Response: Returns the next 20 items in the collection, starting from item 21 to item 40.
Example 3: Retrieve the sixth page of items
API Request: GET with limit=20&offset=5
API Response: Returns an empty response, as there are no items available from item 101 to item 120 in the collection. |
| limit
| number | | specifies the maximum number of items per page. Default 100, Max 100. |
| units
| string | | METERS or FEET |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"location":{"x":"\u003cnumber\u003e","y":"\u003cnumber\u003e","units":"FEET","error_level":"\u003cinteger\u003e","campus_id":"\u003cstring\u003e","building_id":"\u003cstring\u003e","floor_id":"\u003cstring\u003e","associated":"\u003cboolean\u003e","device_mac":"\u003cstring\u003e"}}