• Quick Start

    Overview The UbiTrack platform allows you to collect, store, analyse and visualise data collected from UbiTrack hardware, as well as create rules r...

  • API Response Format

    Overview An HTTP code of 200 is responded for each successful data requests. If there is any error exists, an HTTP code 200 will be given as well a...

  • Generate User Access Token

    Overview The Generate User Access Token call will return a JSON object containing a temporary “token_id” which can be used for all the platform-lev...

  • Socket.IO Document

    Overview This document is the API provided by UbiTrack. It is for reference only. Developers can refer to the development guide for socket.io docum...

  • Time Zone

    Overview Return a collection of time zones.   API URL /api/constants/timezones   HTTP Method GET   Response An HTTP code of 200 is responded for ea...

  • Get Server Time

    Overview Returns the current timestamp.   API URL /api/constants/getservertime   HTTP Method GET   Response An HTTP code of 200 is responded for ea...

  • Anchor: list

    Overview Return a collection of anchor that match the API request parameters.   API URL /api/anchor/query   HTTP Method GET   URL Parameters Nam...

  • Anchor: insert

    Overview Create an anchor.   API URL /api/anchor/create   HTTP Method POST   URL Parameters Name Type Required Description access_token or u...

  • Anchor: update

    Overview Modify an anchor. For example, you could change an anchor's zone,x, or y.   API URL /api/anchor/update   HTTP Method POST   URL Parameters...

  • Anchor: delete

    Overview Delete an anchor.   API URL /api/anchor/delete   HTTP Method POST   URL Parameters   Name Type Required Description access_token or...

  • Tag: list

    Overview Return a collection of tag that match the API request parameters.   API URL /api/tag/query   HTTP Method GET   URL Parameters Name Type...

  • Tag: insert

    Overview Create a tag.   API URL /api/tag/create   HTTP Method POST   URL Parameters Name Type Required Description access_token or user_acc...

  • Tag: update

    Overview Modify a tag. For example, you could change a tag's tag category.   API URL /api/tag/update   HTTP Method POST   URL Parameters Name Ty...

  • Tag: delete

    Overview Delete a tag.   API URL /api/tag/delete   HTTP Method POST   URL Parameters Name Type Required Description access_token or user_acc...

  • Tag Group: list

    Overview Return a collection of tag group that match the API request parameters.   API URL /api/taggroup/query   HTTP Method GET   URL Parameters  ...

  • Tag Group: insert

    Overview Create a tag group.   API URL /api/taggroup/create   HTTP Method POST   URL Parameters   Name Type Required Description access_toke...

  • Tag Group: update

    Overview Modify a tag group. For example, you could change a tag group's name.   API URL /api/taggroup/update   HTTP Method POST   URL Parameters  ...

  • Tag Group: delete

    Overview Delete a tag group.   API URL /api/taggroup/delete   HTTP Method POST   URL Parameters   Name Type Required Description access_toke...

  • Tag Category: list

    Overview Return a collection of tag category that match the API request parameters.   API URL /api/tagclassify/query   HTTP Method GET   URL Parame...

  • Tag Category: insert

    Overview Create a tag category.   API URL /api/tagclassify/create   HTTP Method POST   URL Parameters Name Type Required Description access_...

  • Tag Category: update

    Overview Modify a tag category. For example, you could change a tag  category's name,color.   API URL /api/tagclassify/update   HTTP Method POST   ...

  • Tag Category: delete

    Overview Delete a tag category.   API URL /api/tagclassify/delete   HTTP Method POST   URL Parameters   Name Type Required Description acces...

  • Tag Parameters: list

    Overview Return a collection of tag parameters that match the API request parameters.   API URL /api/tagparamrules/query   HTTP Method GET   URL Pa...

  • Tag Parameters: insert

    Overview Create a tag parameters.   API URL /api/tagparamrules/create   HTTP Method POST   URL Parameters   Name Type Required Description a...

  • Tag Parameters: update

    Overview Modify a tag parameters. For example, you could change a tag parameters's name,description.   API URL /api/tagparamrules/update   HTTP Met...

  • Tag Parameters: delete

    Overview Delete a tag parameters.   API URL /api/tagparamrules/delete   HTTP Method POST   URL Parameters Name Type Required Description acc...

  • Member: list

    Overview Return a collection of member that match the API request parameters.   API URL /api/person/query   HTTP Method GET   URL Parameters   N...

  • Member: insert

    Overview Create a member.   API URL /api/person/create   HTTP Method POST   URL Parameters   Name Type Required Description access_token or ...

  • Member: update

    Overview Modify a member. For example, you could change a member's name, gender, or age.   API URL /api/person/update   HTTP Method POST   URL Para...

  • Member: delete

    Overview Delete a member.   API URL /api/person/delete   HTTP Method POST   URL Parameters Name Type Required Description access_token or us...

  • Member Group: list

    Overview Return a collection of member group that match the API request parameters.   API URL /api/persongroup/query   HTTP Method GET   URL Parame...

  • Member Group: insert

    Overview Create a member group.   API URL /api/persongroup/create   HTTP Method POST   URL Parameters Name Type Required Description access_...

  • Member Group: update

    Overview Modify a member group. For example, you could change a member group's name, type.   API URL /api/persongroup/update   HTTP Method POST   U...

  • Member Group: delete

    Overview Delete a member group.   API URL /api/persongroup/delete   HTTP Method POST   URL Parameters Name Type Required Description access_...

  • Member Category: list

    Overview Return a collection of member category that match the API request parameters.   API URL /api/personclassify/query   HTTP Method GET   URL ...

  • Member Category: insert

    Overview Create a member category.   API URL /api/personclassify/create   HTTP Method POST   URL Parameters Name Type Required Description a...

  • Member Category: update

    Overview Modify a member category. For example, you could change a member category's name, color.   API URL /api/personclassify/update   HTTP Metho...

  • Member Category: delete

    Overview Delete a member category.   API URL /api/personclassify/delete   HTTP Method POST   URL Parameters Name Type Required Description a...

  • Zone: list

    Overview Return a collection of zone that match the API request parameters.   API URL /api/zone/query   HTTP Method GET   URL Parameters Name Ty...

  • Zone: insert

    Overview Create a zone.   API URL /api/zone/create   HTTP Method POST   URL Parameters Name Type Required  Description access_token or user_...

  • Zone: update

    Overview Modify a zone. For example, you could change a zone's name, sorting.   API URL /api/zone/update   HTTP Method POST   URL Parameters Nam...

  • Zone: delete

    Overview Overview Delete a zone.   API URL /api/zone/delete   HTTP Method POST   URL Parameters Name Type Required Description access_token ...

  • E-Fence: list

    Overview Return a collection of e-fence that match the API request parameters.   API URL /api/fence/query   HTTP Method GET   URL Parameters Nam...

  • E-Fence: insert

    Overview Create a e-fence.   API URL /api/fence/create   HTTP Method POST   URL Parameters Name Type Required  Description access_token or...

  • E-Fence: update

    Overview Modify a e-fence. For example, you could change a e-fence's name, type.   API URL /api/fence/update   HTTP Method POST   URL Parameters ...

  • E-Fence: delete

    Overview Delete a e-fence.   API URL /api/fence/delete   HTTP Method POST   URL Parameters Name Type Required Description access_token or use...