The functionality that make up this service and the functions that can be called.
Lists all active entries where the Server is assigned to a user, reseller, or a reseller's sub-user.
Function: GetActiveNullRoutes (parameter1, parameter2)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
Returns: NullRouteListWithDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| NullRouteDetailsList |
NullRoute_Details[] |
A list all NullRoutes with details as defined in the Nullroute_Details class. |
Add a new null route.
Function: AddNullRoute (parameter1, parameter2, parameter3, parameter4, parameter5)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| IPAddress |
String |
NullRoute IP address. |
| ScheduleRemove |
Date |
The schedule remove date. |
| Lock |
Integer |
1 [forTrue] or 0 [for False]. |
Returns: NullRouteDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| NullRouteDetails |
NullRoute_Details |
NullRoute details as defined in the Nullroute_Details class. |
Removes a null route.
Function: RemoveNullRoute (parameter1, parameter2, parameter3)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| IPAddress |
String |
NullRoute IP address. |
Returns: NullRouteRemoveDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| NullRouteRemoveDetails |
NullRoute_Remove_Details |
NullRoute remove details as defined in the Nulloute_Remove_Details class. |
Object - NullRoute_Details
|
Field
|
Type
|
Description
|
| Server_Id |
Integer |
The server Id. |
| NullRoute_IP |
String |
The null route IP address. |
| NullRoute_Add_Time |
Date |
The add time. |
| NullRoute_Remove_Time |
Date |
The remove time. |
| NullRoute_Active |
Boolean |
Indicates active or not. |
| NullRoute_Description |
String |
Description. |
| Schedule_Remove |
Date |
The schedule remove time. |
| Admin_Lock |
Boolean |
Indicates an admin lock or not. |
| Reseller_Lock |
Boolean |
Indicates a reseller lock or not. |
Object - NullRoute_Remove_Details
|
Field
|
Type
|
Description
|
| NullRoute_IP |
String |
The null route IP address. |
| NullRoute_Remove_Time |
Date |
The remove time. |
| NullRoute_Active |
Boolean |
Indicates active or not. |
| Schedule_Remove |
Date |
The schedule remove time. |
Article ID: 230, Created: July 16, 2015 at 2:27 PM, Modified: August 31, 2015 at 1:52 PM