Class SubmitSetupProtocolRequest
- java.lang.Object
-
- io.openems.common.jsonrpc.base.JsonrpcMessage
-
- io.openems.common.jsonrpc.base.AbstractJsonrpcRequest
-
- io.openems.common.jsonrpc.base.JsonrpcRequest
-
- io.openems.backend.common.jsonrpc.request.SubmitSetupProtocolRequest
-
public class SubmitSetupProtocolRequest extends JsonrpcRequest
Submits the Setup Protocol.{ "jsonrpc": "2.0", "id": UUID, "method": "submitSetupProtocol", "params": { "protocol": { "edge": { "id": string }, "customer": { "firstname": string, "lastname": string, "email": string, "phone": string, "address": { "street": string, "city": string, "zip": string, "country": string }, "company": { "name": string } }, "location": { "firstname": string, "lastname": string, "email": string, "phone": string, "address": { "street": string, "city": string, "zip": string, "country": string }, "company": { "name": string } }, "lots": [{ "category": string, "name": string, "serialNumber": string }], "items": [{ "category": string, "name": string, "value": string }], "oem": string } } }
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
METHOD
-
Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest
DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt
-
Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage
JSONRPC_VERSION
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SubmitSetupProtocolRequest
from(JsonrpcRequest request)
CreateSubmitSetupProtocolRequest
from a templateJsonrpcRequest
.com.google.gson.JsonObject
getJsonObject()
Gets the Setup Protocol information asJsonObject
.com.google.gson.JsonObject
getParams()
Gets the paramsJsonObject
of theJsonrpcRequest
.-
Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest
getId, getTimeout, toJsonObject
-
Methods inherited from class io.openems.common.jsonrpc.base.AbstractJsonrpcRequest
getFullyQualifiedMethod, getMethod
-
Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage
from, from, toString
-
-
-
-
Field Detail
-
METHOD
public static final java.lang.String METHOD
- See Also:
- Constant Field Values
-
-
Method Detail
-
from
public static SubmitSetupProtocolRequest from(JsonrpcRequest request) throws OpenemsError.OpenemsNamedException
CreateSubmitSetupProtocolRequest
from a templateJsonrpcRequest
.- Parameters:
request
- the templateJsonrpcRequest
- Returns:
- Created
SubmitSetupProtocolRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
getParams
public com.google.gson.JsonObject getParams()
Description copied from class:AbstractJsonrpcRequest
Gets the paramsJsonObject
of theJsonrpcRequest
.- Specified by:
getParams
in classAbstractJsonrpcRequest
- Returns:
- the params as
JsonObject
-
getJsonObject
public com.google.gson.JsonObject getJsonObject()
Gets the Setup Protocol information asJsonObject
.- Returns:
- the
JsonObject
-
-