{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/landmark/view.json","auth":"required","settings":"559288b86bf22f170075b794","examples":{"codes":[]},"method":"get","params":[{"name":"name","type":"string","default":"","desc":"Name(s) of landmark(s) separated by comma","required":false,"in":"query","ref":"","_id":"563099bff1c0580d00fac64f"},{"name":"groupName","type":"string","default":"","desc":"Name of the group associated with the landmark","required":false,"in":"query","ref":"","_id":"563099bff1c0580d00fac64e"},{"name":"type","type":"string","default":"","desc":"Type of the landmark","required":false,"in":"query","ref":"","_id":"563099bff1c0580d00fac64d"},{"name":"page","type":"int","default":"1","desc":"Page number of the paginated result","required":false,"in":"query","ref":"","_id":"563099bff1c0580d00fac64c"}],"results":{"codes":[{"language":"json","code":"{  \n   \"landmarkResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Dec-07-2015, 09:29 AM UTC\",\n      \"currentPage\":1,\n      \"totalPages\":1,\n      \"landmarks\":[  \n         {  \n            \"landmarkId\":\"409bf4e4-bc40-11e6-989d-4ff7e6b64e2d\",\n            \"name\":\"Client Location\",\n            \"address\":\"34, Costa Rica\",\n            \"latitude\":39.288815,\n            \"longitude\":-77.860099,\n            \"radiusUnit\":\"metres\",\n            \"radius\":150.0,\n            \"icon\":\"Small Truck\",\n            \"type\":\"Supplier\",\n            \"groupName\":\"Customer Group A\",\n            \"color\":\"#15eb15\",\n            \"createdAt\":\"Dec-07-2016, 05:44 AM\",\n            \"modifiedAt\":\"Dec-07-2016, 08:25 AM\",\n            \"firstName\":\"Gary\",\n            \"lastName\":\"Thompson\",\n            \"phoneNumber\":\"\",\n            \"email\":\"gary:::at:::azuga.com\",\n            \"reserved1\":null,\n            \"reserved2\":null,\n            \"reserved3\":null,\n            \"reserved4\":null\n         }\n      ]\n   }\n}","name":"","status":200}]}},"next":{"description":"","pages":[]},"title":"View","type":"endpoint","slug":"view-landmarks","excerpt":"This API provides you with information about all active landmarks present in your account.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/landmark/view.json?groupName=Customer Group A &type=Supplier\",\n  \"title\": \"Sample Request\"\n}\n[/block]\n##API Response explanation\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"code\",\n    \"1-0\": \"message\",\n    \"2-0\": \"generatedAt\",\n    \"3-0\": \"reason\",\n    \"4-0\": \"currentPage\",\n    \"5-0\": \"totalPages\",\n    \"0-1\": \"API Status Code\",\n    \"1-1\": \"API Message (Success/Failure)\",\n    \"2-1\": \"API generation timestamp in UTC\",\n    \"3-1\": \"Reason for failure\",\n    \"4-1\": \"Current page\",\n    \"5-1\": \"Total number of pages in the result\",\n    \"7-0\": \"name\",\n    \"8-0\": \"address\",\n    \"9-0\": \"latitude\",\n    \"10-0\": \"longitude\",\n    \"11-0\": \"radiusUnit\",\n    \"12-0\": \"icon\",\n    \"13-0\": \"type\",\n    \"14-0\": \"groupName\",\n    \"15-0\": \"radius\",\n    \"7-1\": \"Name of the landmark\",\n    \"8-1\": \"Address of the landmark\",\n    \"9-1\": \"Latitude coordinate of the landmark\",\n    \"10-1\": \"Longitude coordinate of the landmark\",\n    \"11-1\": \"Unit of radius (metres, kilometres or miles) of the landmark\",\n    \"12-1\": \"Icon of the landmark\",\n    \"13-1\": \"Type of the landmark\",\n    \"14-1\": \"Name of the group associated with the landmark\",\n    \"15-1\": \"Radius of the landmark\",\n    \"16-0\": \"color\",\n    \"17-0\": \"createdAt\",\n    \"18-0\": \"modifiedAt\",\n    \"19-0\": \"firstName\",\n    \"20-0\": \"lastName\",\n    \"21-0\": \"phoneNumber\",\n    \"22-0\": \"email\",\n    \"23-0\": \"reserved(1-4)\",\n    \"16-1\": \"Color of the landmark\",\n    \"17-1\": \"Landmark creation timestamp in UTC\",\n    \"18-1\": \"Timestamp in UTC when the landmark was updated\",\n    \"19-1\": \"First name of the contact person\",\n    \"20-1\": \"Last name of the contact person\",\n    \"21-1\": \"Phone number of the contact person\",\n    \"22-1\": \"Email address of the contact person\",\n    \"23-1\": \"Reserved variable for future use\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"6-0\": \"landmarkId\",\n    \"6-1\": \"Unique identifier representing the landmark\"\n  },\n  \"cols\": 2,\n  \"rows\": 24\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"563099bff1c0580d00fac64b","user":"55926c39cf9cdb2100b57022","category":{"sync":{"isSync":false,"url":""},"pages":["563095db7581b80d00c51c88","563099bff1c0580d00fac64b","56309bb8f1c0580d00fac659","56309c207581b80d00c51c99","56309dca02aff217007db95e"],"title":"LANDMARK","slug":"landmark","order":9,"from_sync":false,"reference":true,"_id":"5630941c7581b80d00c51c86","__v":5,"version":"559286c6c39c4b2d00127a71","createdAt":"2015-10-28T09:23:40.372Z","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"},"project":"55926c913735880d005f7c65","__v":1,"githubsync":"","createdAt":"2015-10-28T09:47:43.997Z","editedParams":true,"editedParams2":true,"parentDoc":null}

getView

This API provides you with information about all active landmarks present in your account.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

name:
string
Name(s) of landmark(s) separated by comma
groupName:
string
Name of the group associated with the landmark
type:
string
Type of the landmark
page:
integer1
Page number of the paginated result

Result Format


Documentation

[block:callout] { "type": "info", "body": "https://api.azuga.com/azuga-ws/v1/landmark/view.json?groupName=Customer Group A &type=Supplier", "title": "Sample Request" } [/block] ##API Response explanation [block:parameters] { "data": { "0-0": "code", "1-0": "message", "2-0": "generatedAt", "3-0": "reason", "4-0": "currentPage", "5-0": "totalPages", "0-1": "API Status Code", "1-1": "API Message (Success/Failure)", "2-1": "API generation timestamp in UTC", "3-1": "Reason for failure", "4-1": "Current page", "5-1": "Total number of pages in the result", "7-0": "name", "8-0": "address", "9-0": "latitude", "10-0": "longitude", "11-0": "radiusUnit", "12-0": "icon", "13-0": "type", "14-0": "groupName", "15-0": "radius", "7-1": "Name of the landmark", "8-1": "Address of the landmark", "9-1": "Latitude coordinate of the landmark", "10-1": "Longitude coordinate of the landmark", "11-1": "Unit of radius (metres, kilometres or miles) of the landmark", "12-1": "Icon of the landmark", "13-1": "Type of the landmark", "14-1": "Name of the group associated with the landmark", "15-1": "Radius of the landmark", "16-0": "color", "17-0": "createdAt", "18-0": "modifiedAt", "19-0": "firstName", "20-0": "lastName", "21-0": "phoneNumber", "22-0": "email", "23-0": "reserved(1-4)", "16-1": "Color of the landmark", "17-1": "Landmark creation timestamp in UTC", "18-1": "Timestamp in UTC when the landmark was updated", "19-1": "First name of the contact person", "20-1": "Last name of the contact person", "21-1": "Phone number of the contact person", "22-1": "Email address of the contact person", "23-1": "Reserved variable for future use", "h-0": "Field", "h-1": "Description", "6-0": "landmarkId", "6-1": "Unique identifier representing the landmark" }, "cols": 2, "rows": 24 } [/block]

User Information

Try It Out

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