Page 80
APPENDIX D: API Documentation
Introduction
This appendix discusses ways to use the Application Program Interface (API) to
allow third party equipment to remotely access options and settings of the iAM-
AUDIO. It includes specific code examples for commonly used requests. The API
uses JavaScript Object Notation (JSON) as its communication language.
Follow the instructions in the
First Time IP Assignments
section of Chapter 4 to
achieve the required network connection.
API: Presets
Get available presets
Method: GET
URL: /api/cf/presets
Response JSON Object
•
string
unit_name
:
Product Name ("iAM-KTVSPORT")
•
string
model:
Product model ("iAM-Audio")
• string
serial_number
:
Product serial number
•
float
version
:
ReST API version
•
string
result
:
List of Presets without configuration data.
Status Codes:
•
200
OK
•
400
Bad Request
Invalid URL
•
404
Data Not Found
Invalid HTTP method request
•
500
Server Error
Internal Server Error
Example request
:
GET /api/cf/presets
Example response
:
{
"unit_name":"iAM-KTVSPORT",
"model":"iAM-Audio",
"serial_number":"123456",
"version":2,
"result":[
{
"Id": 1,
"Name": "AES 1",
},
{
"Id": 2,
"Name": "AES 2"
},
