Support

Description

This method returns the value of a given receiver parameter.

Exceptions

The following GenRocket exceptions may be thrown by this method:  

• If the requested domainName is not found.
• If the requested receiverName is not found.
• If the requested parameterName is not found.

Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime.

Java

public String receiverParameterGet(String domainName, String receiverName, String parameterName)

REST/Socket Payload Request

Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.

{
  "interfaceType": "Manual",
  "methodName": "receiverParameterGet",
  "parameters": {
    "domainName": "",
    "receiverName": "",
    "parameterName": ""
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload returns the value of the given domain parameterValue.

{
  "responseType": "OK",
  "data": {
     "parameterValue": ""
  }
}