Update Specific Pin on a Zone Map API
Require Authentication
This API is used to update specific pin on a zone map for the company based on combination of deviceID and token.
URL
api/projects/updatepin/:projectID/:projectpinID
Required parameter (in URL)
- :projectID «contains projectID that want to be looked for. It must be put in the URL, e.g: api/projects/updatepin/1/4. To get available projectID, please visit Get Available Zones»
- :projectpinID «contains projectpinID that want to be looked for. It must be put in the URL, e.g: api/projects/updatepin/1/4»
Required parameter (POST)
- deviceID
- token
Optional parameter (POST)
- latitude «if passed, value can not be empty and must be decimal»
- longitude «if passed, value can not be empty and must be decimal»
- new_projectID «contains new projectID (used to change current pin zone ID). Value must exist in database. To get available zone ID, please visit Get Available Zones»
- pintypeID «contains asset type ID. Value must exist in database. If passed, iconID and iconType should be passed too. To get available asset type ID, please visit Get Available Asset Types»
-
name «contains pin name»
- if asset type (pintypeID) have pattern that will be used as default pin name (field pinTypeRuleForPinName is empty), and the pattern result is not empty string. If empty, it will use asset Type name as its name. If this optional field "name" is passed, it will overrides the pattern result.
- iconType «contains icon type. Accepted value: "system", "custom". If passed, iconID should be passed too.»
- iconID «contains iconID based in iconType. Should be used together with iconType parameter. If iconType is "pintype", iconID can be ignored (not passed). "pintype" indicates that it will use default icon based on its asset type (pintypeID). If iconType is "system", iconID value must exist in System-default Icons. If iconType is "custom", iconID value must exist in Custom Icons.»
- description
- serialNumber
- assetTag «in array format [{"type":"existing","value":1},{"type":"new","value":"text"}]. If passed, it will delete all tags assigned to this pins before insert new ones. To delete, pass empty array []. If the type is "new", value must be a string to be stored as tags_text. If the type is "existing", value must be pinstagsID found in Get Available Tags»
- projectgroupID «contains group ID. If passed, value must exist in database, based on projectID or new_projectID. If value is not exist, system will skip this field (leave it blank). To remove group from bin, please pass projectgroupID with 0 (zero) value ( projectgroupID: 0 ). To get available group ID, please visit Get Available Groups»
- manufacturerID «contains manufacturerID. If passed, value must be exist in database. To remove manufacturer from bin, please pass manufacturerID with 0 (zero) value ( manufacturerID: 0 ). To get the manufacturerID, please see Get Available Manufacturers»
- pinAddress1
- pinAddress2
- pinCity
- pinState
- pinCountry
- pinZipCode
- customlocationID «contains customlocationID. If passed, value must be exist in database, or it can have "0" value to skip auto-assigned custom location. If this parameter is passed and pin full address is empty, pin full address will be filled with custom location full address (if any). To remove custom location from bin, please pass customlocationID with 0 (zero) value ( customlocationID: 0 ). To get the customlocationID, please see Get Available Custom Locations»
- vendorID «contains vendorID based in vendor, vendorID value must exist in Vendor.»
Note:
If customlocationID is not passed, but pin latitude and longitude are inside radius of certain custom location, system will automatically fill customlocationID with the nearest custom location. If user decide not to use customlocationID, please always pass customlocationID although its value is 0. Otherwise, it will be filled automatically by system.
If pin address is empty, and not using customlocationID, pin address will be automatically filled by related data from Google API based on latitude and longitude in required parameter. If using customlocationID, address will be filled by custom location address. Related data from Google Maps API is as below:
- pinAddress1 = route + street_number
- pinAddress2
- pinCity = administrative_area_level_2
- pinState = administrative_area_level_1
- pinCountry = country
- pinZipCode = postal_code
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "c43fa596e7916827106b591e2bb026cd",
"assetTag": [{
"type": "existing",
"value": 1
}, {
"type": "new",
"value": "tags api"
}]
}
Example below will reset the pin name to use default pattern pin name specified in asset type. Also, it will change pin's zone ID and delete all assetTag
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "bb602ab13b8090268cd6e3bb9dfa39e2",
"latitude": -6.202423572540,
"longitude": 106.779052734375,
"pintypeID": 1,
"new_projectID": 2,
"name": "",
"iconType": "pintype",
"assetTag": []
}
Possible return HTTP status code
- 200
- 400
- 401
- 404
- 405
Return message
{
"status": "success",
"message": {
"projectpinID": 9,
"projectID": 5,
"projectName": "TEst without icon in the kost dupli",
"projectgroupID": 0,
"groupName": "",
"iconType": "pintype",
"iconID": 0,
"iconURL": "http://localhost/sswebdash/assets/images/icons/pins/appsize/32.png",
"iconName": "Test Icon",
"customlocationID": 1,
"locationName": "test location API edited",
"pinAddress1": "Jalan Anggrek 22-23",
"pinAddress2": "",
"pinCity": "Kota Jakarta Barat",
"pinState": "Daerah Khusus Ibukota Jakarta",
"pinCountry": "ID",
"pinZipCode": "11530",
"latitude": -6.201930522919,
"longitude": 106.7802658081,
"name": "test pin type API",
"description": "",
"serialNumber": "",
"assetTag": [{
"pinstagsID": 1,
"tags_text": "tags"
}, {
"pinstagsID": 5,
"tags_text": "tags api"
}],
"manufacturerID": 0,
"manufacturerName": "",
"createdDate": 1462817660,
"creatorUserID": 3,
"pinType": {
"pintypeID": 2,
"pinTypeName": "test pin type API",
"depthWhenEmpty_cm": 100,
"distanceSensorToFillLine_cm": 10,
"iconType": "system",
"iconID": 1,
"iconURL": "http://localhost/sswebdash/assets/images/icons/pins/appsize/32.png",
"iconName": "Test Icon",
"pinTypeDescription": "",
"pinTypeImageOriginalName": "",
"pinTypeImageURL": "",
"manufacturerID": 0,
"manufacturerName": "",
"pinTypeCreatedDate": 0,
"pinTypeCreatedByUserID": 0,
"pinTypeModifiedDate": 0,
"pinTypeModifiedByUserID": 0,
"total_projectpins": 3
},
"currentAllocatedSensor": [
{
"sensorallocatedID": 1,
"sensorsID": 1,
"sensorstokenID": 1,
"sensorCompany": "LX Group",
"sensorDeviceID": 1231,
"firmwareVersion": "1231",
"sensorName": "tes",
"description": "asdasd",
"allocationDate": 1463685570,
"depthWhenEmpty_cm": 100,
"distanceSensorToFillLine_cm": 10,
"endDate": 0,
"latestSensorDataDate": 1463991683,
"latestSensorData": {
"sensorDeviceID": "91FE572400000000",
"temperatureExist": "N",
"temperatureValue": 0,
"temperatureOkay": "N",
"accelerometer_x": 0,
"accelerometer_y": 0,
"accelerometer_z": 0,
"ultrasoundExist": "Y",
"ultrasound": 47,
"batteryVoltage_mV": 3335,
"signalStrengthExist": "Y",
"signalStrength_rssi_dbm": -97,
"signalStrength_bitErrorRate": 25,
"timestampdata": 1463991683
}
}
]
}
}
Note:
Since customlocationID is optional, if customlocationID is set to 0 and locationName is set to empty string, it indicates that asset type does not have custom location assigned.
Since manufacturerID is optional, if manufacturerID is set to 0 and manufacturerName is set to empty string, it indicates that asset type does not have manufacturer assigned.
currentAllocatedSensor has been sorted by latestSensorDataDate desc.
latestSensorData will contain 1 latest sensor data. But if the latest sensor data ultrasoundExist = 'N', it will find update the ultrasoundExist and ultrasound field with latest ultrasound success data reading, it will do the same for temperatureExist and temperatureValue, signalStrengthExist and signalStrength_rssi_dbm and signalStrength_bitErrorRate