new OperatorApi()
- Version:
- 1.0
Operator service.
Methods
getOperator(callback)
Retrieve the specific operator Retrieve the operator settings and a balance of the operator account.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
OperatorApi~getOperatorCallback | The callback function, accepting three arguments: error, data, response data is of type: Operator |
retrieveOperators(opts, callback)
Retrieve a list of all operators Retrieve the list of operators created and the setting values of each operator.<p></p> ## Size<p></p> * The query parameter `size` is optional (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default value (`size=100`) when `size=0`<br> * Uses the maximum value (`size=1000`) when given a value higher than the maximum value<br>
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
OperatorApi~retrieveOperatorsCallback | The callback function, accepting three arguments: error, data, response data is of type: Operators |
Type Definitions
getOperatorCallback(error, data, response)
Callback function to receive the result of the getOperator operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Operator | The data returned by the service call. |
response |
String | The complete HTTP response. |
retrieveOperatorsCallback(error, data, response)
Callback function to receive the result of the retrieveOperators operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Operators | The data returned by the service call. |
response |
String | The complete HTTP response. |