Difference between revisions of "GetUserStorageInfo"
| (5 intermediate revisions by 2 users not shown) | |||
| Line 21: | Line 21: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object | + | Returns a JSON object containing a [[UserStorageInfo|UserStorageInfo]] Object. |
| − | + | i.e.: | |
| + | { | ||
| + | "StatusCode": 0, | ||
| + | "Severity": 1, | ||
| + | "StatusMessage": "OK", | ||
| + | "Content": { | ||
| + | "SecurityLimit": 0, | ||
| + | "WarningLimit": 0, | ||
| + | "Used": 0, | ||
| + | "Total": 455680, | ||
| + | "Available": 418880, | ||
| + | "Type": 2, | ||
| + | "Unit": 2 | ||
| + | } | ||
| + | } | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | |Exceptions= | ||
| + | Possible error results (included in the GVP general error list) are: | ||
| + | *-2 System.NotSupportedException ''Mirada'' | ||
| + | *211 RecordingSubscriberNotFound ''OpenPlatform, MiViewTv, Mediaroom'' | ||
| + | *212 RecordingSubscriberNotSubscribed ''OpenPlatform, MiViewTv'' | ||
| + | *213 RecordingUnknownError ''OpenPlatform, MiViewTv, Mediaroom'' | ||
| − | |||
| − | |||
|Cache= | |Cache= | ||
| Line 56: | Line 68: | ||
{{!}} Added support for Mirada (does not apply) and Mediaroom. Introduced new parameter targetDeviceId | {{!}} Added support for Mirada (does not apply) and Mediaroom. Introduced new parameter targetDeviceId | ||
{{!}} | {{!}} | ||
| + | {{!}}- valign="top" | ||
| + | ! 7.1 | ||
| + | {{!}} Added support for CPVR | ||
| + | {{!}} José Manuel Escartín | ||
{{!}}} | {{!}}} | ||
Latest revision as of 16:00, 29 April 2019
Description
Retrieves storage status from the external platform, as an UserStorageInfo object. If the external platform provides a Network PVR service (such as the case of MiViewTV), this method will return total, used and available time measured in minutes or hours. In the case of Remote PVR service availability (such as Mediaroom), this method will provide the total, used and available storage measured in bytes from the connected STB hard disk.
This method only applies to MiViewTV and Mediaroom backends.
Mirada's API does not support a method to retrieve user storage data. When the method is invoked by a user associated to Mirada for rPVR, it will return an error message informing the client.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- targetDeviceId (int, optional)
- Allows identifying the user's device (STB) on which the application will be applied, in the case that several DVR devices may exist in the household (does not apply to MiView and Mediaroom)
Returns
Returns a JSON object containing a UserStorageInfo Object.
i.e.:
{
"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": {
"SecurityLimit": 0,
"WarningLimit": 0,
"Used": 0,
"Total": 455680,
"Available": 418880,
"Type": 2,
"Unit": 2
}
}
Exceptions
Possible error results (included in the GVP general error list) are:
- -2 System.NotSupportedException Mirada
- 211 RecordingSubscriberNotFound OpenPlatform, MiViewTv, Mediaroom
- 212 RecordingSubscriberNotSubscribed OpenPlatform, MiViewTv
- 213 RecordingUnknownError OpenPlatform, MiViewTv, Mediaroom
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.4 | Initial method design | |
| 2.4 drop 1 | Added support for Mirada (does not apply) and Mediaroom. Introduced new parameter targetDeviceId | |
| 7.1 | Added support for CPVR | José Manuel Escartín |
See also
- UserStorageInfo object
- RecordingScheduleState enum
- RecordingSchedule object type
- Network_Pvr_Service methods
