Passing Json Data; Saving Changes; Selecting A Version Of An Api Call; Element Descriptions - Multitech MultiConnect rCell MTR-H5 Developer's Manual

2.5

Passing JSON Data

Data can be sent to the rCell by passing a JSON object as the request content or by passing a JSON object in
the URI parameter: data. As an example, the following request uses a RESTful PUT call to edit the current
DHCP configurations by passing in a JSON object with the enabled member set to false
Example: To disable DHCP, send the following request:
https://192.168.2.1/apidhcp?data={"enabled":false}&method=PUT
2.6

Saving Changes

A call to save ( https://[rcell ip]/command/save ) will write current changes to the device settings. Commands
are executed using RESTful POST requests. A full list of commands can be found in section 4.1 Commands.
Example: To save the current changes, send a request to:
https://192.168.2.1/api/command/save?method=POST
2.7

Selecting a Version of an API Call

As the rCell API evolves and new features are added, backwards compatibility can be maintained by setting the
desired API version within the request. The API version can be set through the version URI parameter, or through
the URL path by subscripting the version number with the letter 'v'. If a request has only one version, this value
is ignored.
Example: To use version 1 of the API, all API requests would be made through https://[rcell ip]/api/v1/[request path]
or https://[rcell ip]/api/[request path]?version=1. If a version is not specified, the request will be executed using
the latest API version.
2.8

Element Descriptions

The API provides documentation on collections and elements through https://[rcell ip]/api/help. For a description
of an element or group of elements, use the path to retrieve the data and prepend help to the collection component.
For example, if a user wanted information on the DHCP element enabled ( https://[rcell ip]/api/dhcp/enabled
), they could submit a RESTful GET request to https://[rcell ip]/api/help/dhcp/enabled.
Example: Retrieving a description of the DHCP member enabled.
1 GET https://192.168.2.1/api/help/dhcp/enabled
2
3 Status : HTTP /1.1 200 OK
4
5 " code " : 200 ,
6 " result " :
7 " dhcp_enabled "
8 ,
9 " status " : " success "
10
The API also provides a separate set of help descriptions that are used by the rCell website for context-sensitive
help-on-hover content. The path to each description follows the menu and category embedding of the rCell
website.
8
: " enable or disable DHCP server ( default : true )
Multi-Tech Systems, Inc. MultiConnect
2 REQUESTS
: BOOL "
R
rCell API Developer Guide