Difference between revisions of "High Level API specification Vodafone Proposal"

From PRPL
Jump to: navigation, search
Line 12: Line 12:
  
 
__TOC__
 
__TOC__
 +
 +
== API ==
  
 
{| class="wikitable"
 
{| class="wikitable"

Revision as of 17:46, 16 November 2017

DISCLAIMER The specification below is the draft specification as shared by VF. Therefore, the objects, data-models and object paths on this page do not constitute the final API as adopted by Prpl but are merely one of the proposed approaches.

Background

The high-level API is designed to give services running on top of any internet access device (IAD) or router access to a standardized set of methods to interact with the underlying platform.

The VF proposal is base on reusing the uBus specification.

In a nutshell, every API and low level interaction is implemented by the respective HW manufacturer and exposed as a an object on uBus. Similar to RDK-B's architecture, the higher level service, such as the web UI, can interact with the system via abstracted uBus calls rather than integrating with specific systems.

In line with that logic, the specification below is sorted by objects.

API

User.Accounts
Method Args Response Description
Add {
"Id": "Admin",
"Enabled": True,
"Username": "Administrator",
"Password": "prplFoundation",
"Description": "Home-Gateway administrator.",
"RoleId": "User.Roles.Root"

}

{
"Id": "Admin"

}

Adds a new User Account.

List {
"Limit": 10,
"Offset": 0

}

{

"List": [

{
"Id": "Admin",
"Enabled": True,
"Username": "Administrator",
"Password": "prplFoundation",
"Description": "Home-Gateway administrator.",
"RoleId": "User.Roles.Root"
}

],

"Limit": 10,

"Offset": 0

}

Retrieves a list of User Accounts.

Delete Deletes the specified User Account.