{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/landmark/create.json","auth":"required","settings":"559288b86bf22f170075b794","examples":{"codes":[{"language":"text","code":""}]},"method":"post","params":[{"name":"name","type":"string","default":"","desc":"Name of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a97"},{"name":"latitude","type":"double","default":"","desc":"Latitude coordinate of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a96"},{"name":"longitude","type":"double","default":"","desc":"Longitude coordinate of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a95"},{"name":"address","type":"string","default":"","desc":"Address of the landmark location (Enter either the latitude-longitude or the address. One of them is mandatory)","required":true,"in":"body","ref":"","_id":"571895f4459f6f0e00750587"},{"name":"radius","type":"int","default":"","desc":"Radius of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a94"},{"name":"radiusUnit","type":"string","default":"","desc":"Unit of radius (metre, kilometre or mile) of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a93"},{"name":"icon","type":"string","default":"","desc":"Icon of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a92"},{"name":"type","type":"string","default":"","desc":"Type of the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a91"},{"name":"groupName","type":"string","default":"","desc":"Name of the group associated with the landmark","required":true,"in":"body","ref":"","_id":"5630972f242cda1900198a90"},{"name":"color","type":"string","default":"","desc":"Color of the landmark","required":false,"in":"body","ref":"","_id":"5630972f242cda1900198a8f"},{"name":"firstName","type":"string","default":"","desc":"First name of the contact person associated with the landmark","required":false,"in":"body","ref":"","_id":"5630972f242cda1900198a8e"},{"name":"lastName","type":"string","default":"","desc":"Last name of the contact person associated with the landmark","required":false,"in":"body","ref":"","_id":"5630972f242cda1900198a8d"},{"name":"phoneNumber","type":"string","default":"","desc":"Phone number of the contact person associated with the landmark","required":false,"in":"body","ref":"","_id":"5630972f242cda1900198a8c"},{"name":"email","type":"string","default":"","desc":"Email address of the contact person associated with the landmark","required":false,"in":"body","ref":"","_id":"5630972f242cda1900198a8b"},{"name":"page","type":"int","default":"1","desc":"Page number of the paginated result","required":false,"in":"body","ref":"","_id":"567270a17051a00d007c0cb6"}],"results":{"codes":[{"status":200,"name":"","code":"{  \n   \"restResponseVO\":{  \n      \"code\":200,\n      \"message\":\"Success\",\n      \"reason\":\"\",\n      \"generatedAt\":\"Dec-07-2015, 09:08 AM UTC\",\n      \"currentPage\":null,\n      \"totalPages\":null\n   }\n}\n                          ","language":"json"}]}},"next":{"description":"","pages":[]},"title":"Create","type":"endpoint","slug":"create-landmark","excerpt":"Use this API to create a Landmark. Landmark is a guide to an easily recognizable address that can be configured over an area. These are locations saved in Azuga that you can classify as home, client addresses, job locations etc. Landmarks help you determine if your vehicle is within 1 mile surrounding the landmark and stops and trips that occur to and fro.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"https://api.azuga.com/azuga-ws/v1/landmark/create.json\",\n  \"title\": \"Sample Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"name\\\":\\\"Supplier-7779\\\",\\n   \\\"latitude\\\":36.36669,\\n   \\\"longitude\\\":-121.91816,\\n   \\\"radiusUnit\\\":\\\"metres\\\",\\n   \\\"radius\\\":4.1234,\\n   \\\"icon\\\":\\\"Default\\\",\\n   \\\"type\\\":\\\"Customer\\\",\\n   \\\"groupName\\\":\\\"San Jose\\\",\\n   \\\"color\\\":\\\"#999999\\\",\\n   \\\"firstName\\\":\\\"Gary\\\",\\n   \\\"lastName\\\":\\\"Brown\\\",\\n   \\\"phoneNumber\\\":\\\"4084804433\\\",\\n   \\\"email\\\":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    \"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\": \"The reason for failure\",\n    \"4-1\": \"The current page\",\n    \"5-1\": \"The total number of pages in the result\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"563095db7581b80d00c51c88","user":"55926c39cf9cdb2100b57022","__v":4,"editedParams":true,"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"},"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"},"parentDoc":null,"project":"55926c913735880d005f7c65","createdAt":"2015-10-28T09:31:07.321Z","editedParams2":true}

postCreate

Use this API to create a Landmark. Landmark is a guide to an easily recognizable address that can be configured over an area. These are locations saved in Azuga that you can classify as home, client addresses, job locations etc. Landmarks help you determine if your vehicle is within 1 mile surrounding the landmark and stops and trips that occur to and fro.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
Name of the landmark
latitude:
required
double
Latitude coordinate of the landmark
longitude:
required
double
Longitude coordinate of the landmark
address:
required
string
Address of the landmark location (Enter either the latitude-longitude or the address. One of them is mandatory)
radius:
required
integer
Radius of the landmark
radiusUnit:
required
string
Unit of radius (metre, kilometre or mile) of the landmark
icon:
required
string
Icon of the landmark
type:
required
string
Type of the landmark
groupName:
required
string
Name of the group associated with the landmark
color:
string
Color of the landmark
firstName:
string
First name of the contact person associated with the landmark
lastName:
string
Last name of the contact person associated with the landmark
phoneNumber:
string
Phone number of the contact person associated with the landmark
email:
string
Email address of the contact person associated with 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/create.json", "title": "Sample Request" } [/block] [block:code] { "codes": [ { "code": "{ \n \"name\":\"Supplier-7779\",\n \"latitude\":36.36669,\n \"longitude\":-121.91816,\n \"radiusUnit\":\"metres\",\n \"radius\":4.1234,\n \"icon\":\"Default\",\n \"type\":\"Customer\",\n \"groupName\":\"San Jose\",\n \"color\":\"#999999\",\n \"firstName\":\"Gary\",\n \"lastName\":\"Brown\",\n \"phoneNumber\":\"4084804433\",\n \"email\":null\n}", "language": "json", "name": "Sample Payload" } ] } [/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": "The reason for failure", "4-1": "The current page", "5-1": "The total number of pages in the result", "h-0": "Field", "h-1": "Description" }, "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 }}