MSA Grid RESTful API, Startup Manual

Page: 41 / 53

Install OpenVPN Client
Grid RESTful API Start-up Guide 41
2.6 Firmware Methods
2.6.1 GetDeviceFirmwareVersions
Description: Returns a list of available firmware versions for a given IIoT gateway
HTTP Verb: GET or POST
URL:
/rest/method/fieldpop-api/getDeviceFirmwareVersions
Query String Parameters:
•
happn_token - Token obtained from the login request.
•
deviceID - the IIoT gateway ID (see Section 3.1.1 ).
Body Parameters (JSON):
•
parameters - object containing the following fields:
o
deviceID - the IIoT gateway ID (see Section 3.1.1 ).
Example 1
– GET URL:
/rest/method/fieldpop-api/getDeviceFirmwareVersions?happn_token=eyJ0eXAiOiJKV1QiLC&deviceID=cyberspa
rrow_NkWMIrKbyQ
Example 1
– JSON Response:
{
"message": "Call successful",
"data": {
"SMC": {
"SMC ProtoCast": {
"model": "SMC ProtoCast",
"versions": [
"5.4.0",
"5.4.1",
"5.4.2"
]
}
}
},
"error": null
}
Example 3
– POST URL:
/rest/method/fieldpop-api/getDeviceFirmwareVersions?happn_token=eyJ0eXAiOiJKV1QiLC
Example 3
– JSON Payload:
{
"parameters": {
"deviceID": "cybersparrow_NkWMIrKbyQ"
}
}
Example 3
– JSON Response:
{
"message": "Call successful",
"data": {
"SMC": {
"SMC ProtoCast": {
"model": "SMC ProtoCast",
"versions": [
"5.4.0",
"5.4.1",
"5.4.2"
]
}
}
},
"error": null
}