Update Specific Asset Type API

Require Authentication

This API is used to update specific asset type for the company based on combination of deviceID and token.

URL

api/manageassets/updatetype/:pintypeID

Required parameter (in URL)

:pintypeID «contains departmentID that want to be updated. It must be put in the URL, e.g: api/manageassets/updatetype/2»

Required parameter (POST)

deviceID
token

Optional parameter (POST)

pinTypeName «contains asset type name»
iconType «contains icon type. Should be used together with iconID parameter. Accepted value: "system", "custom".»
iconID «contains iconID based in iconType. Should be used together with iconType parameter. If iconType is "system", iconID value must exist in System-default Icons. If iconType is "custom", iconID value must exist in Custom Icons.»
pinTypeDescription
manufacturerID «contains manufacturerID. If passed, value must be exist in database. To remove manufacturer from asset type, please pass manufacturerID with 0 (zero) value ( manufacturerID: 0 ). To get the manufacturerID, please see Get Available Manufacturers»
pinSize
depthWhenEmpty_cm «contains height of bin/container from bottom to fill line in centimeters.»
distanceSensorToFillLine_cm «contains distance of sensor from top of fill line. in centimeters.»
pinTypeRuleForPinName «contain pattern that will be used as default pin name. If pin name is not empty, user-defined pin name will overrides this default pattern.» All words that match with predefined pattern below will be replaced with the related data. [Address1] [Address2] [City] [State] [Country] [Postcode] [BinTypeName] However, user can still add his own words outside the predefined key. But keep in mind that Pin Name can only store 255 characters and must not empty. Exceeding characters will be removed.
pinTypeImageURL «contain asset type image in base64 encoded string. Max file size allowed is 2048 KB. Must be used together with pinTypeImageURL_extension.»
pinTypeImageURL_extension «contains asset type image file extension, without dot. Only accept: "gif","png","jpg". Must be used together with pinTypeImageURL.»
pinTypeImageOriginalName «contain asset type image original file name, exclude file extension. Will only be saved if there is an image in pinTypeImageURL. If pinTypeImageOriginalName is empty or not passed, value will be the encrypted file name that is saved.»
diffFillLevelToCollect «contains minimum number of fill level differences to be considered as collected, in positive number (integer) in %.»
minPrevFillLevelToCollect «contains minimum previous fill level before collected to be considered as collected, in positive number (integer) in %.»

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "521881966918944426679ffdcbff0f1e", 
	"pinTypeName": "Edit Type Name"
}

Possible return HTTP status code

Return message

{
	"status": "success",
	"message": {
		"pintypeID": 510,
		"pinTypeName": "Edit Type Name",
		"iconType": "system",
		"iconID": 1,
		"iconURL": "https://dashboard.superfy.com/assets/images/icons/default/appsize/wheelie.png",
		"pinTypeDescription": "from API",
		"pinTypeRuleForPinName": "[Address1][Address2]-[BinTypeName]",
		"pinTypeImageOriginalName": "12well_physed-superJumbo.jpg",
		"pinTypeImageURL": "",
		"manufacturerID": 50,
		"manufacturerName": "Ahai",
		"pinSize": "2.5",
		"depthWhenEmpty_cm": 100,
		"distanceSensorToFillLine_cm": 10,
		"pinTypeCreatedDate": 1692260726,
		"pinTypeCreatedByUserID": 90,
		"pinTypeModifiedDate": 1692262607,
		"pinTypeModifiedByUserID": 90,
		"diffFillLevelToCollect": 10,
		"minPrevFillLevelToCollect": 20,
		"total_projectpins": 0
	}
}

Note: 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.

Superfy Platform API Documentation