RPC Methods

Clears all API applications for the given portal.

Parameters:
  • portal The code of the portal.
Return:
  • The number of deleted API applications.

Retrieves a list of portals for the given API application.

Parameters:
  • client_id The identifier of the API application.
Return:
  • The codes of the portals belonging to the API application.

Lists all API applications for the given portal.

Parameters:
  • portal The code of the portal.
Return:
  • A list of API application identifiers.

Lists all API applications for all portals.

The result set is of the following format:

{ "1": [ "client_id1", "client_id2" ] }

Return:
  • A dictionary containing all API applications, grouped by portal code.

Removes the given API application from the given portal.

Parameters:
  • portal The code of the portal.
  • client_id The API application identifier.
Return:
  • True iff the API application has been deleted successfully.

Stores the given API application in the given portal.

Parameters:
  • portal The code of the portal.
  • client_id The API application identifier.
Return:
  • True iff the API application has been added successfully.

Lists all available portals.

The result set is of the following format:

{ "1": { "url": "https://mijn.gntel.nl", "description": "The main portal" } }

Return:
  • A dictionary describing all portals.

Collects meta information for all portals the user is known for.

The result is of the following format:

[ , ]

Parameters:
  • client_id The id of the API application.
  • email The email address of the user.
Return:
  • A list of dictionaries with meta information per portal.

Removes the given portal.

Parameters:
  • portal The code of the portal to remove.
  • url The URL of the portal to remove.
Return:
  • the code of the deleted portal on success.

Creates or updates the portal matching the given URL. The portal code is automatically determined.

Parameters:
  • url The base URL of the portal, e.g. https://mijn.gntel.nl/
  • description A short description of the portal.
  • portal_auth_id OAuth2 client_id for authorize rpc requests on portal.
  • portal_auth_secret OAuth2 client_secret for authorize rpc requests on portal.
  • token_url OAuth2 URL endpoint for obtain access_token.
Return:
  • The code of the portal on success.

Clears all users for the given portal.

Parameters:
  • portal The code of the portal.
Return:
  • The number of deleted users.

Retrieves a list of portal entries belonging to the given user.

Parameters:
  • email The email address of the user.
Return:
  • A list of portal codes.

Lists all users for the given portal.

Parameters:
  • portal The code of the portal.
Return:
  • A list of email addresses.

Lists all users for all portals.

The result set is of the following format:

{ "1": [ "piet@gntel.nl", "radim@gfxpulse.sk" ], "2": [ "piet@gntel.nl", "test@voipxs.nl" ] }

**WARNING**: this may be a large set!

Return:
  • A dictionary containing all users, grouped by portal code.

Removes the given user from the given portal.

Parameters:
  • portal The code of the portal.
  • email The email address of the user.
Return:
  • True iff the user is deleted.

Adds the given user to the given portal.

Parameters:
  • portal The code of the portal.
  • email The email address of the user.
Return:
  • True iff the user is added.

Returns a list of all methods available in the current entry point

Returns the documentation of the given method name.

Parameters:
  • method_name Name of a method available for current entry point (and protocol)
Return:
  • Documentation text for the RPC method

Returns an array describing the signature of the given method name.

The result is an array with: - Return type as first elements - Types of method arguments from element 1 to N

Parameters:
  • method_name Name of a method available for current entry point (and protocol)
Return:
  • An array describing types of return values and method arguments

Call multiple RPC methods at once.

Parameters:
  • calls (list) - An array of struct like {"methodName": string, "params": array }