{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/timecard/{shiftid}.json","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"shiftid","type":"string","default":"","desc":"Unique identifier representing the shift","required":true,"in":"path","ref":"","_id":"5a0ab0ddeae5e100104c68f4"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n \"serverResponse\":{ \n \"result\":[ \n { \n \"eventTime\":1460174400000,\n \"location\":{ \n \"address\":{ \n \"city\":\"Palo Alto\",\n \"country\":\"USA\",\n \"formattedAddress\":\"791 Gailen Ave, Palo Alto, CA 94303, USA\",\n \"state\":\"CA\",\n \"zip\":\"94303\",\n \"locality\":null\n },\n \"latitude\":37.423786,\n \"longitude\":-122.107151,\n \"accuracy\":80.0,\n \"altitude\":-1.0,\n \"bearing\":-1.0,\n \"speed\":-1.0,\n \"time\":1459333661000,\n \"mapProviderId\":null\n },\n \"id\":22,\n \"eventType\":1,\n \"comments\":\"Shift Start\"\n },\n { \n \"eventTime\":1460175900000,\n \"location\":{ \n \"address\":{ \n \"city\":\"San Jose\",\n \"country\":\"USA\",\n \"formattedAddress\":\"1422 Ford Ave, San Jose, CA 95110, USA\",\n \"state\":\"CA\",\n \"zip\":\"95110\",\n \"locality\":null\n },\n \"latitude\":37.315740,\n \"longitude\":-121.874609,\n \"accuracy\":75.0,\n \"altitude\":-1.0,\n \"bearing\":-1.0,\n \"speed\":-1.0,\n \"time\":1461217105000,\n \"mapProviderId\":null\n },\n \"id\":23,\n \"eventType\":2,\n \"comments\":\"Break Start\"\n },\n { \n \"eventTime\":1460177100000,\n \"location\":{ \n \"address\":{ \n \"city\":\"San Jose\",\n \"country\":\"USA\",\n \"formattedAddress\":\"433 Parrott St, San Jose, CA 95112, USA\",\n \"state\":\"CA\",\n \"zip\":\"95112\",\n \"locality\":null\n },\n \"latitude\":37.307071,\n \"longitude\":-121.852881,\n \"accuracy\":80.0,\n \"altitude\":-1.0,\n \"bearing\":-1.0,\n \"speed\":-1.0,\n \"time\":1460447542000,\n \"mapProviderId\":null\n },\n \"id\":24,\n \"eventType\":3,\n \"comments\":\"Break End\"\n },\n { \n \"eventTime\":1460260740000,\n \"location\":{ \n \"address\":{ \n \"city\":\"Hayward\",\n \"country\":\"USA\",\n \"formattedAddress\":\"495 Meek Ave, Hayward, CA 94541, USA\",\n \"state\":\"CA\",\n \"zip\":\"94541\",\n \"locality\":null\n },\n \"latitude\":37.663851,\n \"longitude\":-122.087907,\n \"accuracy\":75.0,\n \"altitude\":-1.0,\n \"bearing\":-1.0,\n \"speed\":-1.0,\n \"time\":1461217105000,\n \"mapProviderId\":null\n },\n \"id\":25,\n \"eventType\":4,\n \"comments\":\"Shift ENd\"\n }\n ],\n \"error\":null\n }\n}\n","name":""}]},"settings":"559288b86bf22f170075b794"},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view","excerpt":"Use this API to get the details of a particular shift, by passing the shift ID as a parameter. Only one shift ID can be passed in a single API call. This API returns the shift timestamp and location.","body":"[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Sample Request\",\n \"body\": \"https://api.azuga.com/azuga-ws/v1/timecard/10956.json\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Description\",\n \"0-0\": \"eventTime\",\n \"0-1\": \"Time stamp of the event in milliseconds\",\n \"1-0\": \"address\",\n \"2-0\": \"city\",\n \"3-0\": \"country\",\n \"1-1\": \"Address of the shift location\",\n \"2-1\": \"City of the shift location\",\n \"3-1\": \"Country of the shift location\",\n \"4-0\": \"formattedAddress\",\n \"4-1\": \"Concatenated string containing the complete address\",\n \"5-0\": \"state\",\n \"6-0\": \"zip\",\n \"7-0\": \"locality\",\n \"8-0\": \"latitude\",\n \"6-1\": \"Postal code of the shift location\",\n \"5-1\": \"State of the shift location\",\n \"7-1\": \"Locality or the surrounding area of the shift location\",\n \"8-1\": \"Latitude coordinates of the shift location\",\n \"9-0\": \"longitude\",\n \"10-0\": \"accuracy\",\n \"11-0\": \"altitude\",\n \"12-0\": \"bearing\",\n \"10-1\": \"Precision of the location point\",\n \"9-1\": \"Longitude coordinates of the shift location\",\n \"11-1\": \"Elevation of the shift location\",\n \"12-1\": \"Used for navigation and direction\",\n \"13-0\": \"speed\",\n \"14-0\": \"time\",\n \"15-0\": \"mapProviderId\",\n \"16-0\": \"id\",\n \"14-1\": \"Address generation timestamp in milliseconds\",\n \"13-1\": \"Speed of the vehicle which is tracked\",\n \"15-1\": \"Unique identifier of the map provider (Google map, Bing map etc,.)\",\n \"16-1\": \"Unique shift identifier\",\n \"17-0\": \"eventType\",\n \"17-1\": \"Type of event. There are 4 types of events:\\n1 - Shift start, 2 - Break start, 3 - Break End, 4 - Shift End\",\n \"18-0\": \"comments\",\n \"18-1\": \"Additional information about the shift activity\",\n \"19-0\": \"error\",\n \"19-1\": \"Error message\"\n },\n \"cols\": 2,\n \"rows\": 20\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"573325b4a6a9c40e00e138df","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"TIMECARD","slug":"timecard","order":10,"from_sync":false,"reference":true,"_id":"573306dea6a9c40e00e13875","version":"559286c6c39c4b2d00127a71","project":"55926c913735880d005f7c65","createdAt":"2016-05-11T10:18:06.559Z","__v":0},"createdAt":"2016-05-11T12:29:40.631Z","parentDoc":null,"project":"55926c913735880d005f7c65","user":"5656a3dd5656350d001d83a0","githubsync":"","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"},"__v":4}
getView
Use this API to get the details of a particular shift, by passing the shift ID as a parameter. Only one shift ID can be passed in a single API call. This API returns the shift timestamp and location.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
shiftid:
required
string
Unique identifier representing the shift