Difference between revisions of "GetUserServices"

From Gvp-public
Jump to navigation Jump to search
 
(3 intermediate revisions by one other user not shown)
Line 9: Line 9:
 
|ParamRequired=required
 
|ParamRequired=required
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
 
{{Api_Parameter|
 
ParamName=offset
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The offset number of the returned values for this request
 
}}
 
{{Api_Parameter|
 
ParamName=limit
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The limit number of values for this request
 
}}
 
{{Api_Parameter|
 
ParamName=subscriptionId
 
|ParamType=int
 
|ParamRequired=required
 
|ParamDescription=The subscriptionId that wants request the data.
 
 
}}
 
}}
 +
  
 
|Returns=
 
|Returns=
Line 35: Line 18:
  
 
{
 
{
:    "Offset",
 
:    "Limit",
 
:    "Count",
 
:    "List":
 
 
::    [ Array of [[Service]] objects ]
 
::    [ Array of [[Service]] objects ]
 
}
 
}
  
 
|Exceptions=
 
|Exceptions=
* [[InvalidSubscriptionException]]
+
InvalidServiceId=275 (In all error cases)
  
 
|Cache=
 
|Cache=

Latest revision as of 11:15, 28 November 2017

Description

Returns the list of Service objects active for the 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 an array of Service.

Example:

{

[ Array of Service objects ]

}


Exceptions

InvalidServiceId=275 (In all error cases)


Caching

This method is not cached.


Known issues

None


Version history

API Version Number Change description Changes author
2.4 Initial method DRAFT design Francisco Milagro


See also