GetKeyValues - Revision history

Id02660 at 15:33, 13 November 2017

2017-11-13T15:33:36Z

Id02660 at 15:33, 13 November 2017

2017-11-13T15:33:10Z

Id02224 at 13:26, 3 September 2015

2015-09-03T13:26:27Z

Id02224 at 13:25, 3 September 2015

2015-09-03T13:25:13Z

Id02224 at 13:24, 3 September 2015

2015-09-03T13:24:38Z

Id02224 at 13:22, 3 September 2015

2015-09-03T13:22:10Z

Id02224 at 13:18, 3 September 2015

2015-09-03T13:18:21Z

Id02224 at 13:17, 3 September 2015

2015-09-03T13:17:30Z

Id02224: Created page with "{{Api_Method_Spec| Description=Returns a Person object for an specific ID. This method can be used by anonymous login or logged user. |Parameters= {{Api_Parameter| Para..."

2015-09-03T13:13:04Z

Created page with "{{Api_Method_Spec| Description=Returns a Person object for an specific ID. This method can be used by anonymous login or logged user. |Parameters= {{Api_Parameter| Para..."

New page

{{Api_Method_Spec|
Description=Returns a [[Person]] object for an specific ID.

This method can be used by anonymous login or logged user.

|Parameters=

{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=personId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of an person that wants to be returned on the request.
}}

|Returns=
Returns a JSON object containing a [[Person]] object.

'''Example:'''

{
: "Statuscode": 0,
: "Severity": 1,
: "StatusMessage": "OK",
: "Content":
:: { Object of [[Person]] }
}

|Exceptions=
* [[InvalidPersonException]]

|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=

}}

@@ Line 2: / Line 2: @@
 Description=Gets a tree of components-groups-keys.
-This method can be used by anonymous login or logged user.
+This method doesn't need token
 |Parameters=

← Older revision		Revision as of 13:26, 3 September 2015
Line 50:		Line 50:
	}		}

		+	In case component, groups or keys doesn't exist, the response contains a void content {}.

	\|Exceptions=		\|Exceptions=

@@ Line 45: / Line 45: @@
 ::::        "ANALYTICS_BATCH_SIZE": 100,
 ::::        "ANALYTICS_BATCH_TIME_LIMIT": 86400
 :::      }
 ::    }

@@ Line 40: / Line 40: @@
 :     <span style="color: #a11">"Severity"</span>: 1,
 :     <span style="color: #a11">"StatusMessage"</span>: "OK",
-:     <span style="color: #a11">"Content"</span>:
+:     <span style="color: #a11">"Content"</span>:{
-::       { Object of [[Person]] }
+::       "global": {
+}
 |Exceptions=
-* [[Exceptions#InvalidInputParameter InvalidInputParameter]]
+* [[StatusCode#InvalidInputParameter | InvalidInputParameter]]
 |Cache=

@@ Line 46: / Line 46: @@
 |Exceptions=
-* None
+* [[Exceptions#InvalidInputParameter InvalidInputParameter]]
 |Cache=

@@ Line 7: / Line 7: @@
 {{Api_Parameter|
-ParamName=token
+ParamName=instanceId
-|ParamType=String
+|ParamType=Int
 |ParamRequired=required
-|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
+|ParamDescription=A valid InstanceID
 }}
 {{Api_Parameter|

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=Returns a [[Person]] object for an specific ID.
+Gets a tree of components-groups-keys.
 This method can be used by anonymous login or logged user.
@@ Line 13: / Line 13: @@
 }}
 {{Api_Parameter|
-ParamName=personId
+ParamName=components
-|ParamType=int
+|ParamType=String
 |ParamRequired=required
-|ParamDescription=ID of an person that wants to be returned on the request.
+|ParamDescription=Comma-separated components' name to filter the response tree. It is case insensitive.
 }}
 |Returns=
-Returns a JSON object containing a [[Person]] object.
+First, second and third levels of ParameterComponent tree, which contains filtered keys inside groups inside components
 '''Example:'''
@@ Line 34: / Line 46: @@
 |Exceptions=
-* [[InvalidPersonException]]
+* None
 |Cache=
@@ Line 49: / Line 61: @@
 ! Changes author
 {{!}}- valign="top"
-! 1.0
+! 2.4
 {{!}} Initial method design
 {{!}} Harley Cabral