Uri Parameters - Multitech MultiConnect rCell MTR-H5 Developer's Manual

2 REQUESTS
Example: Retrieving a more human-readable description of the DHCP member enabled.
GET https://192.168.2.1/api/help/Setup/DHCP/Settings/Enabled
1
2
3 Status : HTTP /1.1 200 OK
4
5 " code " : 200 ,
6 " result " :
7 " S e t u p _ D H C P _ S e t t i n g s _ E n a b l e d "
8 ,
9 " status " : " success "
10
2.9

URI Parameters

URI parameters are reserved keys that are used to modify the functionality of API calls, override HTTP header
values, and bundle multiple API requests together. Below is a list of available URI keys and descriptions of their
functionality.
URI Key Description
fields Applies a RESTful action to multiple collections/elements. Each request path is separated by a comma. Requested
data within a field is returned using the path by replacing '/' characters with ' ' characters.
Example:
1 GET https://192.168.2.1/api?fields=lan/ip,serial/client/enabled&method=GET
2
3 Status
4
5 " code "
6 " result "
7 " lan_ip "
8 " s e r i a l _ c l i e n t _ e n a b l e d "
9 ,
10 " status "
11
method Allows passing RESTful action (GET, PUT, POST, & DELETE) in URI. This overrides the HTTP header method.
See section 2.1
apply Allows the request to be applied at the given timestamp without restarting. Currently, only apply=now is
supported.
token Authorized Login Token. This can be passed to authorize an API call. A token is returned upon a successful
login. If a user is logged in, the whoami request will return the users current token. See section 2.2
inactivity Allows requests to be made without bumping the user's token expiration date. This is useful for automated polling
loops that still want to allow a user to timeout due to inactivity (inactivity=true)
session Reserved for internal use. This member will be overwritten.
data Allows passing a JSON Object in the URI.
default This option will retrieve the factory defaults of a collection when using a RESTful GET request, and set a collection
to its factory defaults when using a RESTful PUT request. (default=true)
version Sets the API version to use during the request. See section 2.7
username User's login name. Used for logging into the API. See section 2.2
password User's login password. Used for logging into the API. See section 2.2
logoutUser User to be logged out. Only used on api/logout request. See section 2.3
Multi-Tech Systems, Inc. MultiConnect
: " Check to use a DHCP server on network "
: HTTP /1.1 200 OK
: 200 ,
:
: "192.168.2.1"
: " success "
R
rCell API Developer Guide
,
: false
9