Add/Update RIP configuration file
RIP configurations are linked to a specific computer, identified by its ComputerGUID. If any RIP configuration file with the ComputerGUID is found, the RIP configuration file is updated, otherwise a new RIP configuration file is added.
URL:
POST http://api.aurelon.com/api/v2/configuration
Request Headers:
Content-Type : multipart/form-data
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
Form data 1: required
-
- Name: JsonString
- Content-Type: application/json
- {“ComputerGUID”:”00000000-0000-0000-0000-000000000000″}
The GUID of the RIP Computer is passed as ComputerGUID
Form data 2: required
-
- Name: RIP.xml (input file element can have any name)
- Content-Type: application/xml
- The XML file of the configuration
Response:
Content type of the response is in JSON format
Success:
- 200 OK : “Configuration successfully added”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 415 Unsupported Media Type : {“Message”:”This request is not properly formatted”}
- 401 Unauthorized : {“Message”: “”HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””ComputerGUID” required”}
- 400 Bad Request : {“Message”:”Validation of ComputerGUID failed”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Example of XML configuration file: here
Get Configuration
Downloads the RIP configuration file with ComputerGUID if found.
URL:
GET http://api.aurelon.com/api/v2/configuration/<ComputerGUID>
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Response:
Content type is application/xml and contains the XML of the configuration of RIP Computer. Or content type application/json when with the error content.
Success:
- 200 OK : Configuration XML
Error:
- 401 Unauthorized : {“Message”: “Invalid MisKey”}
- 401 Unauthorized : {“Message”:””HardwareHash” header is invalid”}
- 404 Not Found : {“Message”:”ComputerGUID not found”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Get Site List
Receives list of active sites identified by its serial number
URL:
GET http://api.aurelon.com/api/v2/configuration/sites
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Response:
Content type application/json and contains the JSON of the known sites identified by the serial number.
Success:
- 200 OK : Array of sites
Ex:
[{
“SiteGUID”:”8447e5b0-99ac-11e7-a2d0-215af4f8ef85″,
“SerialNumber”:333674,
“Location”:null,
}, {
…
}]
Error:
- 401 Unauthorized : {“Message”: “Invalid MisKey”}
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Get Site Configuration
Receives list of active devices/queues and RIPs of the serial number
URL:
GET http://api.aurelon.com/api/v2/configuration/site/<SerialNumber>
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Response:
Content type application/json and contains the JSON of the known configurations at the site identified by the serial number.
Success:
- 200 OK : Array of computers, it’s devices and their queues.
Ex:
[{
“ComputerGUID”:”8447e5b0-99ac-11e7-a2d0-215af4f8ef85″,
“Name”:”myrip.company.domain”,
“Modified”:”2018-06-27T07:56:36Z”,
“Devices”:[{
“DeviceGUID”:”6da06b44-20ee-11e6-b287-07f164aa386e”,
“Name”:”Durst Rhotex 322″,
“Modified”:”2018-06-27T07:56:36Z”,
“DriverID”:1601
}, {
…
}]
}, {
…
}]
Error:
- 401 Unauthorized : {“Message”: “Invalid MisKey”}
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 404 Not Found : {“Message”:”SerialNumber not found”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Configuration Sync
Update list of active devices/queues in a RIP
URL:
POST http://api.aurelon.com/api/v2/configuration/sync
Request Headers:
Content-Type : application/json
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing:
- ComputerGUID – required – the Computer GUID
- DeviceList – required – Array of objects per device. Each object containing:
- DeviceGUID – required – active Device GUIDs at RIP
- QueueList – Array of active Queue GUIDs at RIP
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Configuration successfully saved”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 415 Unsupported Media Type : {“Message”:”This request is not properly formatted”}
- 401 Unauthorized : {“Message”: “”HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””ComputerGUID” required”}
- 400 Bad Request : {“Message”:””DeviceList” field is required”}
- 400 Bad Request : {“Message”:””QueueList” field is required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Add/Update RIP
If any RIP with ComputerGUID is found the RIP is updated, otherwise a new RIP is added.
URL:
POST http://api.aurelon.com/api/v2/configuration/rip
Request Headers:
Content-Type : application/json
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing:
- ComputerGUID – required – the Computer GUID
- ComputerName – name of the computer or DNS name
- OperatingSystem – OS type and version
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Computer details successfully saved”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
- 401 Unauthorized : {“Message”: “”HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””ComputerGUID” required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Add/Update Device
If any device with DeviceGUID is found the device is updated, otherwise a new device is added if it is part of the license. If the DeviceGUID is not part of the license an error is returned.
URL:
POST http://api.aurelon.com/api/v2/configuration/device
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing:
- DeviceGUID – required – the Device GUID
- ComputerGUID – required – the RIP on which this device is installed
- Name
- Type
- MediaType
- MediaSize
- MediaSource
- Manufacturer
- Model
- DriverID (unique driver ID from HUB database)
- ConnectionURI
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Device successfully saved”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 Not Found : {“Message”:”DeviceGUID is not found”}
- 415 Unsupported Media Type : {“Message”:”This request is not properly formatted”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””DeviceGUID” required”}
- 400 Bad Request : {“Message”:””ComputerGUID” required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Add/Update Queue
If any queue with QueueGUID is found the queue is updated, otherwise a new queue is added.
URL:
POST http://api.aurelon.com/api/v2/configuration/queue
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing:
- QueueGUID – required – the Queue GUID
- DeviceGUID – required
- ProfileName
- Name
- MediaType
- MediaSize
- MediaSource
- QueueType
- DriverSettings
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Queue successfully saved”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 Not Found : {“Message”:”DeviceGUID is not found”}
- 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””DeviceGUID” required”}
- 400 Bad Request : {“Message”:””QueueGUID” required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Delete Device
Delete the specified device.
URL:
DELETE http://api.aurelon.com/api/v2/configuration/device/<DeviceGUID>
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Device successfully deleted”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 Not Found : {“Message”:”DeviceGUID is not found”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””DeviceGUID” value required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Delete Queue
Delete the specified queue.
URL:
DELETE http://api.aurelon.com/api/v2/configuration/queue/<QueueGUID>
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Device successfully deleted”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 Not Found : {“Message”:”QueueGUID is not found”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””QueueGUID” value required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}