Add New Zone API
Require Authentication
This API is used to add new zone for the company based on combination of deviceID and token.
Zone creation has a limit number of zone that can be created, depends on user account type.
URL
api/projects/add
Required parameter (POST)
- deviceID
- token
- projectName «contains zone name»
Optional parameter (POST)
- projectDescription
- projectAddress1
- projectAddress2
- projectCity
- projectState
- projectCountry
- projectZipCode
- projectLatitude «If empty, it will get the latitude from Google API based on its address. If address is empty, it will use current company latitude»
- projectLongitude «If empty, it will get the longitude from Google API based on its address. If address is empty, it will use current company longitude»
- duplicatedFromProjectID «If not empty, it will duplicate all asset locations from the projectID mentioned in this duplicatedFromProjectID, only if that projectID is exist»
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "bb602ab13b8090268cd6e3bb9dfa39e2",
"projectName": "test zone API",
"projectDescription": "description zone API",
"projectAddress1": "Anggrek Cakra 12",
"projectAddress2": "Kemanggisan",
"projectCity": "Jakarta Barat",
"projectState": "Jakarta",
"projectCountry": "Indonesia",
"projectZipCode": "11530"
}
Possible return HTTP status code
- 201
- 400
- 401
- 405
Return message, contains newly created project
{
"status": "success",
"message": {
"projectID": 5,
"projectName": "test zone API",
"projectDescription": "description zone API",
"projectIconURL": "http:\/\/localhost\/mapmybins\/assets\/images\/icons\/pin.png",
"projectAddress1": "Anggrek Cakra 12",
"projectAddress2": "Kemanggisan",
"projectCity": "Jakarta Barat",
"projectState": "Jakarta",
"projectCountry": "Indonesia",
"projectZipCode": "11530",
"projectLatitude": -6.20242357254,
"projectLongitude": 106.77906036377,
"projectCreatedDate": 1449582720,
"projectModifiedDate": 1449582720,
"projectCreatorUserID": 3,
"projectModifiedByUserID": 3,
"total_projectpins": 0,
"total_projectgroup": 0
}
}
Note:
If zone address (projectAddress1, projectAddress2, projectCity, projectState, projectCountry, projectZipCode) is passed but projectLatitude or projectLongitude is not passed, system will automatically add projectLatitude and projectLongitude value based on geographical coordinate of the address.
If "projectLatitude" or "projectLongitude" is empty, both of them will be filled with company coordinates.
Still empty? It will be filled with default coordinates.