Skip to content

Commands

Jump to bottom
Vincent edited this page Oct 23, 2017 · 1 revision

Commands

With the new version 0.9 there are new features (commands) available.
Here you can find all commands:

Command
ADDCLI
REMCLI
SETCLIP
SETCLIH
SENDRQ
GETRQ
ADDCLI
Description:
Adds a new client session.
Paramter(s):
  • #url=<string>
  • #method=<string>
  • (optional) #jsonToArray=<bool>
  • (optional) <key>=<value>
Result(s):
  1. <string/clientid>
  2. <int/statusCode>
  3. <int/errorCode>
Status Codes:
  • 100 success
  • 101 failed
REMCLI
Description:
Removes an added client session.
Paramter(s):
  1. <int/clientid>
 Result(s):
  1. <string/clientid>
  2. <int/statusCode>
  3. <int/errorCode>
Status Codes:
  • 200 success
  • 201 failed
SETCLIP
Description:
Sets parameters of an client sessionif client session exists.
Paramter(s):
  • #clientid=<int>
  • (optional) #url=<string>
  • (optional) #method=<string>
  • (optional) #jsonToArray=<bool>
  • (optional) <key>=<value>
Result(s):
  1. <string/clientid>
  2. <int/statusCode>
  3. <int/errorCode>
Status Codes:
  • 300 success
  • 301 failed
SETCLIH
Description:
Sets headers of an client session if exists.
Paramter(s):
  • #clientid=<int>
  • <headerDefinition>
 Result(s):
  1. <string/clientid>
  2. <int/statusCode>
  3. <int/errorCode>
Status Codes:
  • 400 success
  • 401 failed
SENDRQ
Description:
Sends a request depending on its input.
Paramter(s):
Normal-Request:
  • #url=<string>
  • #method=<string>
  • (optional) #jsonToArray=<bool>
  • (optional) <key>=<value>
Client-Request:
  • #clientid=<int>
  • (optional) #url=<string>
  • (optional) #method=<string>
  • (optional) #jsonToArray=<bool>
  • (optional) <key>=<value>
Result(s):
  1. <string/requestid>
  2. <int/statusCode>
  3. <int/errorCode>
Status Codes:
  • 500 success
  • 501 failed
GETRQ
Description:
Gathers the result and removes the given request.
Paramter(s):
  1. <int/requestid>
 Result(s):
  1. <string/requestid>
  2. <int/statusCode>
  3. <int/errorCode>
Status Codes:
  • 600 success
  • 601 failed
  • 602 pending

Glossary

clientid
is the unique id of each created client. It refers to the given parameters and (optionally) set headers.

statusCode
is the returned status of the executed task. The status result depends on which command was executed.

Although, there is one error of the main application. This will be 2.

errorCode
is the returned ArmA 3 error code. More information

key=value
is a given HTTP parameter pair.
For example: http://httpbin.org/get?**test=2**

headerDefinition
is the input for a custom or specific HTTP header.
For example: Authority: myVerySecretAuthKey
More information about HTTP Headers

Clone this wiki locally