API Method - Receivers

This method is used to list the Receiver names of a given Domain.

Exceptions

The following GenRocket exceptions may be thrown by this method:

• If the requested domainName is not found.

Runtime Method Signature

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

public List<String> receivers(String domainName)

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": "receivers",
  "parameters": {
    "domainName": ""
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload returns the list of zero or more Generator names for the given Attribute.

{
  "responseType": "OK",
  "data": [
    {
      "receiverName": ""
    },
    {
      "receiverName": ""
    },
    {
      "receiverName": ""
    }
  ]
}