Web APITransponders
Transponders
Transponder assignments in their own right — create, update, end, and locate one.
https://api.locantra.deGet one transponder assignment
https://api.locantra.de/transponderReturns a single transponder assignment. ID is the assignment's own ID, not the chip code printed on the transponder.
Create a transponder assignment
https://api.locantra.de/transponderAssigns a physical transponder for a period of time, optionally to an order. TransponderID is the chip code printed on the transponder, not an assignment ID. Give OrderID to attach the new assignment to an order, or leave it out to keep the assignment unattached. A chip code that is still assigned elsewhere in the requested time range is rejected with 400. Category and Tags classify the assignment independently of the order it belongs to.
Update a transponder assignment
https://api.locantra.de/transponderChanges the label, the order, the classification or the end of one transponder assignment. Name, OrderID, Category, Tags and AssignEnd are the only fields this operation can change; an omitted field is left unchanged, and a request that changes nothing is rejected with 400. AssignEnd must be in the future. OrderID given as an empty string detaches the assignment from its order; given an order ID it moves the assignment to that order, which must belong to your organisation. Category is cleared by an empty string and Tags by an empty array.
End a transponder assignment
https://api.locantra.de/transponder/endEnds one transponder assignment at the current time. ID is the assignment's own ID, not the chip code printed on the transponder.
Get the recorded path of transponder assignments
https://api.locantra.de/transponder/pathReturns the recorded positions of one or more transponder assignments over time, as one flat list. AssignmentID is an assignment's own ID, not the chip code printed on the transponder; repeat the parameter for several, at most 200 per request. Limit (default 100, maximum 1000) caps the positions returned per assignment. A single assignment your organisation does not own rejects the whole request with 403.
Get the latest position of one transponder assignment
https://api.locantra.de/transponder/positionReturns the most recent recorded position of one transponder assignment. AssignmentID is the assignment's own ID, not the chip code printed on the transponder; an assignment your organisation does not own is rejected with 403. Data is null when the assignment has no recorded position in the requested window.
List transponder assignments
https://api.locantra.de/transpondersLists the transponder assignments of your organisation, across every order. Give at least one filter or All=true. Each row carries both AssignmentID (the assignment's own ID) and TransponderID (the physical chip code). Category selects assignments in any of the given categories and Tag assignments carrying at least one of the given tags; each takes at most 50 values per request. 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.