JSON Object Example
{
    "Timeout": 0,
    "Server": "https://api.example.com/clientcreate.asmx",
    "Action": "http://api.example.com/CreateC",
    "PostXML": "<?xml version=\"1.0\" encoding=\"utf-8\"?><soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\"><soap:Body><req:CreateC xmlns:req=\"http://api.example.com/\"><NAME xsi:type=\"xsd:string\">str</Name></req:CreateC></soap:Body></soap:Envelope>",
    "Keyword1": "",
    "Keyword2": "",
    "Keyword3": "",
    "UserName": "",
    "UserPassword": "",
    "AdditionalHeaders": "",
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "Device_Id": 112457,
    "Id": 991330,
    "Task_Type_Id": 10,
    "Name": "SOAP test"
}

Fields Description

Field Type Required/Optional Description

Server

 string

required

The address (URL) under which the web service is available.

Example:
"Server" : "https://api.example.com/clientcreate.asmx"

Action

string

required

The request URI.

PostXML

string

required

The body of the XML request.

Keyword

string

optional

In the Keyword keys, you can specify one or more words or phrases that you wish to search for in the response.

UserName

string

optional

This field contains a username for SOAP authentication.

Example:
"UserName""demo_username"

UserPassword

string

optional

This field contains a password for SOAP authentication.

Example:
"Password""demo_password"

AdditionalHeaders

string

optional

Application-specific information about the SOAP messages.

DNSResolveMode string optional POSSIBLE VALUES:

  • Device Cached
  • Non Cached
  • TTL Cached
  • External DNS Server

For detailed explanation please see the “DNS Mode Option” article.

DNSserverIP string optional Field for a custom DNS server IP address.

For detailed explanation please see the “DNS Mode Option” article.

Device_Id

Int32

required

READ ONLY Field. Unique device ID.

Example:
"Device_Id": 8550

Id

Int32

required

*Only for edit operations

READ ONLY Field. Unique task ID.

Example:
"Id": 17714

Task_Type_Id

Int32

required

The ID of the task type.

Example:
"Task_Type_Id": 10

Name

String

optional

Task name.

Example:
"Name""SOAP"

Timeout

Int32

optional

This field defines maximum time value (in mseconds) for task execution.

Example:
"Timeout": 0