GetInstanceSettings

Description

Returns the InstanceSettings object that represents all the configurations of a certain Instance (GVP_INSTANCES). This allows the devices to know the set of configurations for the instance and to customize end user applications for that instance.

Parameters

• token (String, optional)

A valid token for identifying the API session context and logged user. InstanceSettings can be called without any token.

• instanceId (int, required)

The ID of the instance we want to check the settings

• deviceType (int, optional)

The device type used in the request. This is not used

Returns

Returns a JSON object containing an InstanceSettings object

Example:

{

InstanceSettings object

}

Exceptions

• InvalidInstanceException: If the InstanceId provided doesn't exist.

Caching

This method is cached.

Known issues

None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral

See also

• InstanceSettings object type
• Configuration Service methods