Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Returns the InstanceSettings object that represents all the configurations of a certain Instance (GVP_INSTANCES). This allows the devices to kn..."
{{Api_Method_Spec|
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=optional
|ParamDescription=A valid token for identifying the API session context and logged user. InstanceSettings can be called without any token.
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The ID of the instance we want to check the settings
}}
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=optional
|ParamDescription=The device type used in the request. This is not used
}}
|Returns=
Returns a JSON object containing an [[InstanceSettings]] object
'''Example:'''
{
: <span style="color: #219;">[[InstanceSettings]] object</span>
}
|Exceptions=
* [[StatusCode#InvalidInstanceException|InvalidInstanceException]]: If the InstanceId provided doesn't exist.
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[InstanceSettings]] object type
* [[UNIAPI_Specification#Configuration Service| Configuration Service]] methods
}}
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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=optional
|ParamDescription=A valid token for identifying the API session context and logged user. InstanceSettings can be called without any token.
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The ID of the instance we want to check the settings
}}
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=optional
|ParamDescription=The device type used in the request. This is not used
}}
|Returns=
Returns a JSON object containing an [[InstanceSettings]] object
'''Example:'''
{
: <span style="color: #219;">[[InstanceSettings]] object</span>
}
|Exceptions=
* [[StatusCode#InvalidInstanceException|InvalidInstanceException]]: If the InstanceId provided doesn't exist.
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
* [[InstanceSettings]] object type
* [[UNIAPI_Specification#Configuration Service| Configuration Service]] methods
}}
