Page
100
Preset Activation
Method: PATCH
URL: /api/cf/presets/<int:preset ID>/activate
URL parameters:
•
preset ID
-- preset ID (Number greater than zero)
Response JSON Object
On Success
•
string
unit_name
:
Product Name ("IAM-ETZ-G4")
•
string
model:
Product model ("iAM_MIX_IP)
• string
serial_number
:
Product serial number
•
float
api_version
:
REST API version
•
string
warning
:
Message
•
string
message
:
Message
•
integer
status
:
HTTP status code
On Failure
•
integer
status
:
HTTP status code.
•
string
action:
Help message
• string
message
:
Error message.
Status Codes:
•
200
OK
Request accepted for processing
•
400
Bad Request
Invalid URL
•
404
Data Not Found
Invalid HTTP method request
•
500
Server Error
Internal Server Error
Example request
:
PATCH /api/cf/presets/5/activate
Example response
:
A.
On Success:
{
"status": 200,
"unit_name": "iAM-Series",
"api_version": 2,
"warning": "",
"serial_number": "123456",
"model": "iAM-Mix-IP",
"message": "Preset 5:T-S-M-A is set for recall"
}
B.
On Failure:
{
"status": 404,
"action": "For more information about preset recall, please see API
document.",
"message": "Preset not found for Id: 55"
}
