Application Settings API Basics

API Methods

Method NameAccess URIMethodsDescription
get_summaryintellivoid/v1/application/settings/get_summaryGETPOSTReturns a summary of all the variables, their types and space used.
dumpintellivoid/v1/application/settings/dumpGETPOSTDumps all the data stored between the Application and the User
clearintellivoid/v1/application/settings/clearGETPOSTDeletes all the data stored between the Application and the User
addintellivoid/v1/application/settings/addGETPOSTAdds/overwrites a variable
deleteintellivoid/v1/application/settings/deleteGETPOSTDeletes a specific variable
getintellivoid/v1/application/settings/getGETPOSTReturns the value of the requested variable by name
appendintellivoid/v1/application/settings/appendGETPOSTAppends data to a Array/List variable

API Authentication

All these API methods requires authentication using your Application ID, Secret Key and Access Token

The following authentication methods are available
  • Basic HTTP Authentication
  • GET/POST Parameter

Basic HTTP Authentication

You can authenticate by providing your Application ID via the username field and your Secret Key via the password field but you must provide the Access Token either in the GET parameter or POST parameter using access_token

GET/POST Parameter

You can provide your authentication details via a GET Parameter or within a POST (multipart/form-data), the parameter names that is applicable to both methods is application_id for your Application ID, secret_key for your secret key and access_token for your Access Token

Obtaining an Access Token

You can obtain an Access Token by authenticating the user to your Application, for more information see COA API Introduction

Troubleshooting

All API responses returns a X-Request-ID header with a unique value set with every response you get. It is important to log this request ID if you encounter unexpected issues and server-side errors. Intellivoid can use this ID to get more details about the request and troubleshoot the error.

Data protection

To protect your data, we do not store the information our server returns to your client, the only data we keep track of is the request data you sent and server-side details that are not visible in the request such as exception dumps, cache information and so on. This information is automatically deleted from our server after two weeks. This data is used to troubleshoot any problems with our services and to address them accordingly.

Error Codes

Intellivoid Services API uses error codes to return errors, to learn how error codes work see Intellivoid - Error Codes

This API has it's own set of error codes but it does incorporate COAs error codes if a error is to arise related to COA, for more information see COA Error Codes

The table below will show all the possible error codes and explain what do they mean. All errors related to Application Settings will have the type SETTINGS as shown below
{
  "success": false,
  "response_code": 400,
  "error": {
    "error_code": 6,
    "message": "Variable already exists and cannot be overwritten",
    "type": "SETTINGS"
  }
}

Application Settings Error codes

Error CodeMessageObsoleteDescription
1Missing parameter ‘type’falseThe server was expecting the parameter ‘type’ which was not provided by the client
2Invalid variable typefalseThis error can be a generic error, see the error message for more details
3Missing parameter ‘name’falseThe server was expecting the parameter ‘name’ which was not provided by the client
4Missing parameter ‘value’falseThe server was expecting the parameter ‘value’ which was not provided by the client
5Variable name cannot be emptyfalseThe parameter ‘name’ cannot be empty
6Variable already exists and cannot be overwrittenfalseThe server is refusing to overwrite an existing variable because the parameter “overwrite” was enabled
7The value cannot be parsed, expected JSON datafalseThe server was expecting JSON data in the ‘value’ parameter but couldn't parse
8Invalid data in valuefalseThis error is returned when there is invalid data in the ‘value’ parameter which is not applicable to the data type, the message will contain more information about the error
9Maximum Application size exceededfalseThe changes cannot be made because the maximum size for this Application’s storage for settings/variables has exceeded. You need to remove data to free up space
10Variable not foundfalseThe requested variable does not exist in the current context
11Append not applicable to this variable typefalseThe server refuses to append data to this variable type because it’s not supported, only list and arrays are supported
12Invalid value in parameter ‘by’falseThe parameter ‘by’ only accepts “index” or “key” as values
13Delete is not applicable to this variable typefalseThe server is refusing to delete data from a variable because it’s only applicable to List & Array types
14Cannot remove value by Index on array data typefalseYou can’t delete data by index on a array data type since arrays are a key and value pair