After :ref:`connecting to the DebugServer<started:connecting>`, you can send commands in the form of :ref:`requests<api:requests>`. For every :ref:`request<api:requests>` sent the DebugServer will reply with a :ref:`response<api:responses>`. The general format of :ref:`requests<api:requests>`/:ref:`responses<api:responses>` are shown below:
Note
All :ref:`requests<api:requests>` and :ref:`responses<api:responses>` are in JSON format.
Requests are sent to the DebugServer to execute a command. A Request will always have a "name" field.
- The "args" field is a JSON object representing the key-val arguments for the command
| Key | Type | Description | Values | Required |
|---|---|---|---|---|
| "name" | String | Name of command to call | Always | |
| "args" | JSON | Arguments to pass to command | When a command takes an argument(s) |
// Request
{
"name": "commandName",
"args": {
"arg1": "value",
"arg2": true
}
}Responses are sent back by the DebugServer after completing a Request. A Response will always have a "status" field which will either be "OK" (successful command) or "FAIL" (failed command).
- The "data" field is present when a successful command returns a value.
- The "message" field is present when a command raises an error.
| Key | Type | Description | Values | Present |
|---|---|---|---|---|
| "status" | String | Result of a command | "OK" or "FAIL" | Always |
| "data" | Command specific | Return value of a command | Depends on command | When a command returns a value |
| "message" | String | Error message of failed command | When a command returns an error |
// Success Response
{
"status": "OK",
"data": <command return value>
}
// Failure Response
{
"status": "FAIL",
"message": "Error message description"
}