Difference between revisions of "GetInstanceSettings (Blender)"

From Gvp-public
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 22: Line 22:
 
}}
 
}}
 
|Returns=
 
|Returns=
Returns a JSON object containing an [[InstanceSettings]] object
+
Returns a JSON object containing an [[InstanceSettings]] object.
 +
In the new implementation, the images for the age ratings and the country codes are taken from Content Api
  
 
'''Example:'''
 
'''Example:'''
Line 31: Line 32:
  
 
|Exceptions=
 
|Exceptions=
* [[StatusCode#InvalidInstanceException]]
+
* [[StatusCode#InvalidInstanceException|InvalidInstanceException]]
* [[StatusCode#InvalidInstanceException]]
+
* [[StatusCode#MissingRequiredParameterException|MissingRequiredParameterException]]
* [[StatusCode#MissingRequiredParameterException]]
 
  
 
|Cache=
 
|Cache=

Latest revision as of 14:42, 3 November 2025

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. In the new implementation, the images for the age ratings and the country codes are taken from Content Api

Example:

{

InstanceSettings object

}


Exceptions


Caching

This method is cached.


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial method design for Blender Rafael Morón


See also