Zum Inhalt springen
Web APIAnchor Tags

Anchor Tags

Fixed reference tags with a known position, used to anchor the tracking picture to the site.

5 operationsBase https://api.locantra.de

Get one anchor

GEThttps://api.locantra.de/anchor
Permission anchors.read

Returns a single anchor of your organisation. TransponderID is the chip code printed on the anchor's own transponder — the anchor hardware's identity, not a transponder assignment's ID. PositionKind says how to read Position: world for a geographic position, image for x and y pixel coordinates on the floor plan image, carried in Position's Longitude and Latitude.

Create an anchor

POSThttps://api.locantra.de/anchor
Permission anchors.manageIdempotent

Registers an anchor at a known place. TransponderID is the chip code printed on the anchor's own transponder — the anchor hardware's identity, not a transponder assignment's ID. PositionKind says how to read Position: world for a geographic position, image for x and y pixel coordinates on the floor plan image, carried in Position's Longitude and Latitude. Give BuildingFloorID to place the anchor on a building floor, which sets its building and FloorIndex from that floor; give BuildingID alone to place it in a building without naming a floor; give neither to leave it unplaced. The anchor belongs to your organisation, taken from your credential.

Update an anchor

PATCHhttps://api.locantra.de/anchor
Permission anchors.manage

Changes an anchor's name, its position or where it is placed. Those are the only fields this operation can change — TransponderID is fixed at creation — and an omitted field is left unchanged. PositionKind says how to read Position: world for a geographic position, image for x and y pixel coordinates on the floor plan image, carried in Position's Longitude and Latitude. The placement is resolved as a whole: as soon as BuildingID, BuildingFloorID or FloorIndex is given, the ones left out are cleared, so send the placement you want in full. An empty BuildingFloorID takes the anchor off its floor; an empty BuildingID takes it out of its building as well.

Delete an anchor

DELETEhttps://api.locantra.de/anchor
Permission anchors.manage

Deletes an anchor. The positions already recorded from it are kept.

List anchors

GEThttps://api.locantra.de/anchors
Permission anchors.read

Lists the anchors of your organisation. TransponderID is the chip code printed on the anchor's own transponder — the anchor hardware's identity, not a transponder assignment's ID. PositionKind says how to read Position: world for a geographic position, image for x and y pixel coordinates on the floor plan image, carried in Position's Longitude and Latitude. Results are paged with Limit (default 100, maximum 1000) and Offset; the response envelope's Page carries the applied Limit and the Total match count.