prosyst-ms1-api.json

{"apiVersion":"1.0","swaggerVersion":"1.2","basePath":"/api","resourcePath":"/deviceManagement/gateway","apis":[{"path":"/deviceManagement/gateway/notifyChanges","description":"publishGatewayChangeEvent","operations":[{"method":"POST","summary":"Publish changes of gateway attributes","notes":"publishGatewayChangeEvent","type":"ResultJson","nickname":"publishGatewayChangeEvent","parameters":[{"name":"connectionState","description":"connectionState","defaultValue":"","required":false,"type":"ConnectionStateChangeEventJson","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false"}]},{"path":"/deviceManagement/gateway/{businessKey}/connectionState","description":"getConnectionState","operations":[{"method":"GET","summary":"Get the current connection state of the gateway specified by the businessKey","notes":"getConnectionState","type":"ConnectionStateChangeEventJson","nickname":"getConnectionState","parameters":[{"name":"businessKey","description":"A unique identifier of a gateway","defaultValue":"","required":true,"type":"integer","format":"int64","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ConnectionStateChangeEventJson"}],"deprecated":"false"}]},{"path":"/deviceManagement/gateway/{businessKey}/vpnConnectionState","description":"getVpnConnectionState","operations":[{"method":"GET","summary":"Get the current VPN connection state of the gateway specified by the businessKey","notes":"getVpnConnectionState","type":"ConnectionStateChangeEventJson","nickname":"getVpnConnectionState","parameters":[{"name":"businessKey","description":"A unique identifier of a gateway","defaultValue":"","required":true,"type":"integer","format":"int64","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ConnectionStateChangeEventJson"}],"deprecated":"false"}]}],"models":{"ConnectionStateChangeEventJson":{"id":"ConnectionStateChangeEventJson","description":"","required":["businessKey","isOnline"],"extends":"","properties":{"businessKey":{"type":"string","description":"A unique identifier of a gateway"},"isOnline":{"type":"boolean","description":"Whether the status is online (=true) or not (=false)"}}},"ResultJson":{"id":"ResultJson","description":"","required":["status"],"extends":"","properties":{"status":{"type":"string","description":"","enum":["ok","error"]},"message":{"type":"string","description":"Contains the cause in case of an error"},"translatedMessage":{"type":"string","description":"Contains the translation in case of an error or the translation key if no translation is present"},"info":{"$ref":"object","description":"Contains additional information in some cases of an error"}}}}}