{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/trackme.json","auth":"required","method":"post","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"trackMeFeed\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"generatedAtInMillis\":1484634432036,\n      \"token\":\"TAFYO3UFP\",\n      \"alive\":true,\n      \"url\":\"http://fleetdev2.azuga.com:8000/locate/4648/TAFYO3UFP\"\n   }\n}","name":""}]},"settings":"559288b86bf22f170075b794","params":[{"name":"latitude","type":"string","default":"","desc":"Latitude coordinate of your current location","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7efa"},{"name":"longitude","type":"string","default":"","desc":"Longitude coordinate of your current location","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7ef9"},{"name":"destLatitude","type":"string","default":"","desc":"Latitude coordinate of the destination","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7ef8"},{"name":"destLongitude","type":"string","default":"","desc":"Longitude coordinate of the destination","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7ef7"},{"name":"vehicleId","type":"string","default":"","desc":"Unique identifier of the vehicle. Either the vehicleId or userId is mandatory","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7ef6"},{"name":"userId","type":"string","default":"","desc":"Unique identifier of the driver. Either the vehicleId or userId is mandatory","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7ef5"},{"name":"ttl","type":"int","default":"","desc":"Time to live i.e.duration for which the link remains active. The value specified in the request needs to be in seconds.","required":true,"in":"body","ref":"","_id":"5951f61163f39000159e7ef4"},{"name":"message","type":"string","default":"","desc":"Short text describing the TrackMe link","required":false,"in":"body","ref":"","_id":"5951f61163f39000159e7ef3"}]},"next":{"description":"","pages":[]},"title":"Create","type":"endpoint","slug":"create","excerpt":"Use this API to generate a link to view your map location and trip status in real time. You can share this link with anyone within or outside the Azuga community. The recipient of the link can view your trip details and estimated time of arrival at the destination.  \n\nAlong with creating a link for tracking, this API also generates a unique ID (token) for the TrackMe link.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sample Request\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/trackme.json\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"latitude\\\":\\\"35.384375\\\",\\n   \\\"longitude\\\":\\\"-97.221660\\\",\\n   \\\"destLatitude\\\":\\\"35.392426\\\",\\n   \\\"destLongitude\\\":\\\"-97.264345\\\",\\n   \\\"vehicleId\\\":\\\"a3ee7b4d-f016-11e5-8786-ddaf892ed854\\\",\\n   \\\"userId\\\":\\\"a3f5cd56-f016-11e5-a6c9-6ff214bbb6cc\\\",\\n   \\\"ttl\\\":600,\\n   \\\"message\\\":null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Sample Payload\"\n    }\n  ]\n}\n[/block]\n##API Response Explanation\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"code\",\n    \"1-0\": \"message\",\n    \"2-0\": \"generatedAtInMillis\",\n    \"3-0\": \"token\",\n    \"4-0\": \"alive\",\n    \"5-0\": \"url\",\n    \"0-1\": \"API status code\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-1\": \"Unique identifier representing the TrackMe link\",\n    \"4-1\": \"Boolean to indicate if the TrackMe link is active or not\",\n    \"5-1\": \"Link to track your location\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5951f531f5c13700153381b1","project":"55926c913735880d005f7c65","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["559286c7c39c4b2d00127a72","55928a98c39c4b2d00127a83","5592bd7b9a68220d00f1c3db","5593dcaf0e82e81700334e25","5594342f0c33bd0d000595a3","563081713998420d00a509e4","5630941c7581b80d00c51c86","56309f4ff1c0580d00fac666","567923b8239fac0d00c7df25","573306dea6a9c40e00e13875","577a288fd051530e00f65563","579af3982b865e17005a4357","57ee06aa1e42900e0014a374","5951f49a63f39000159e7ef1","5951f4c563f39000159e7ef2","598951542a9dfc000fcacd40","5b3375cc98cb500003e4b363","5bbcd4e29667280003084100"],"_id":"559286c6c39c4b2d00127a71","createdAt":"2015-06-30T12:08:38.768Z","project":"55926c913735880d005f7c65","releaseDate":"2015-06-30T12:08:38.768Z","__v":18,"forked_from":"559286b6c39c4b2d00127a6e"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"TRACKME","slug":"trackme","order":9999,"from_sync":false,"reference":false,"_id":"5951f4c563f39000159e7ef2","project":"55926c913735880d005f7c65","version":"559286c6c39c4b2d00127a71","createdAt":"2017-06-27T06:01:41.941Z","__v":0},"user":"5656a3dd5656350d001d83a0","createdAt":"2017-06-27T06:03:29.017Z","githubsync":"","__v":4,"parentDoc":null}

postCreate

Use this API to generate a link to view your map location and trip status in real time. You can share this link with anyone within or outside the Azuga community. The recipient of the link can view your trip details and estimated time of arrival at the destination. Along with creating a link for tracking, this API also generates a unique ID (token) for the TrackMe link.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

latitude:
string
Latitude coordinate of your current location
longitude:
string
Longitude coordinate of your current location
destLatitude:
string
Latitude coordinate of the destination
destLongitude:
string
Longitude coordinate of the destination
vehicleId:
string
Unique identifier of the vehicle. Either the vehicleId or userId is mandatory
userId:
string
Unique identifier of the driver. Either the vehicleId or userId is mandatory
ttl:
required
integer
Time to live i.e.duration for which the link remains active. The value specified in the request needs to be in seconds.
message:
string
Short text describing the TrackMe link

Result Format


Documentation

[block:callout] { "type": "info", "title": "Sample Request", "body": "https://api.azuga.com/azuga-ws/v1/trackme.json" } [/block] [block:code] { "codes": [ { "code": "{ \n \"latitude\":\"35.384375\",\n \"longitude\":\"-97.221660\",\n \"destLatitude\":\"35.392426\",\n \"destLongitude\":\"-97.264345\",\n \"vehicleId\":\"a3ee7b4d-f016-11e5-8786-ddaf892ed854\",\n \"userId\":\"a3f5cd56-f016-11e5-a6c9-6ff214bbb6cc\",\n \"ttl\":600,\n \"message\":null\n}", "language": "json", "name": "Sample Payload" } ] } [/block] ##API Response Explanation [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "code", "1-0": "message", "2-0": "generatedAtInMillis", "3-0": "token", "4-0": "alive", "5-0": "url", "0-1": "API status code", "1-1": "API Message (Success/Failure)", "2-1": "API generation timestamp in UTC", "3-1": "Unique identifier representing the TrackMe link", "4-1": "Boolean to indicate if the TrackMe link is active or not", "5-1": "Link to track your location" }, "cols": 2, "rows": 6 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}