Difference between revisions of "GetToolboxToken"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns a list of Channel registered under de root channel specified as channel Root in the Instance configuration. It automatically filte...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=Returns a list of [[Channel]] registered under de root channel specified as channel Root in the Instance configuration.
+
Description=Returns a Toolbox token from toolbox service
 
   
 
   
It automatically filters the results to return only enable channel in the logged Instance, including the adult channels.
+
It returns a toolbox token valid for the number of times configured in gvp (1 by default) to a valid registered GVP user
  
  
Line 14: Line 14:
 
}}
 
}}
  
}}
 
  
  
 
|Returns=
 
|Returns=
 
Returns a JSON object containing a Token (Toobox).
 
Returns a JSON object containing a Token (Toobox).
 
'''Example:'''
 
  
 
{
 
{
:    <span style="color: #a11">"Offset"</span>: 0,
+
:    <span style="color: #a11">StatusCode"</span>: 0,
:    <span style="color: #a11">"Limit"</span>: 100,
+
:    <span style="color: #a11">"Severity"</span>: 1,
:    <span style="color: #a11">"Count"</span>: 6,
+
:    <span style="color: #a11">"StatusMessage"</span>: "OK",
 
:    <span style="color: #a11">"Content"</span>:
 
:    <span style="color: #a11">"Content"</span>:
::       Token: "479dfd9dca6281e97c9dcab03dd7045c780eceaeaa3be35caae12b3d1280bfaac2aaaffbda4865cf806a8649cddbe753"
+
::       <span style="color: #a11"> Token</span>: "479dfd9dca6281e97c9dcab03dd7045c780eceaeaa3be35caae12b3d1280bfaac2aaaffbda4865cf806a8649cddbe753"
 
}
 
}
  

Latest revision as of 13:02, 4 March 2016

Description

Returns a Toolbox token from toolbox service

It returns a toolbox token valid for the number of times configured in gvp (1 by default) to a valid registered GVP user

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.


Returns

Returns a JSON object containing a Token (Toobox).

{

StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":
Token: "479dfd9dca6281e97c9dcab03dd7045c780eceaeaa3be35caae12b3d1280bfaac2aaaffbda4865cf806a8649cddbe753"

}


Exceptions

  • AccessDeniedException (84)


Caching

This method is not cached.


Known issues

None


Version history

API Version Number Change description Changes author
3.2 Initial method design Alberto Los Santos


See also