{"id":13095,"date":"2016-06-22T08:53:28","date_gmt":"2016-06-22T13:53:28","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=13095"},"modified":"2016-07-13T11:28:36","modified_gmt":"2016-07-13T16:28:36","slug":"uri-parameters","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/mtr-software\/mtr-api-reference\/rcell_api_requests\/uri-parameters\/","title":{"rendered":"URI Parameters"},"content":{"rendered":"

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.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
URI Key<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
fields<\/td>\nApplies 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.\n<\/td>\n<\/tr>\n
method<\/td>\nAllows passing RESTful action (GET, PUT, POST, & DELETE) in URI. This overrides the HTTP header method.<\/td>\n<\/tr>\n
apply<\/td>\nAllows the request to be applied at the given timestamp without restarting. Currently, only apply=now is supported.<\/td>\n<\/tr>\n
token<\/td>\nAuthorizes an API call. A token is returned after a successful login. If a user is logged in, the whoami request will return that user’s current token.<\/td>\n<\/tr>\n
inactivity<\/td>\nAllows requests to be made without bumping the user’s token expiration date. This is useful for automated polling loops that would otherwise allow a user to timeout due to inactivity. (inactivity<\/strong>=true<\/strong>)<\/td>\n<\/tr>\n
session<\/td>\nReserved for internal use. This member will be overwritten.<\/td>\n<\/tr>\n
data<\/td>\nAllows you to pass a JSON Object in the URI.<\/td>\n<\/tr>\n
default<\/td>\nRetrieves the factory defaults of a collection when using a RESTful GET request, and sets a collection to its factory defaults when using a RESTful PUT request. (default<\/strong>=true<\/strong>)<\/td>\n<\/tr>\n
version<\/td>\nSets the API version expectation for that request.<\/td>\n<\/tr>\n
username<\/td>\nStores a user’s login name. Used for logging into the API.<\/td>\n<\/tr>\n
password<\/td>\nStores a user’s login password. Used for logging into the API.<\/td>\n<\/tr>\n
logoutUser<\/td>\nNames the user you are logging out. Use this parameter for an api\/logout request only.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h3>\n

Behavior of the “fields” key<\/strong>:<\/p>\n

GET https:\/\/192.168.2.1\/api?fields=lan\/ip,serial\/client\/enabled&method=GET\r\n\r\nStatus: HTTP\/1.1 200 OK\r\n{\r\n    \"code\" : 200, \r\n    \"result\" : {\r\n        \"lan_ip\" : \"192.168.2.1\",\r\n        \"serial_client_enabled\" : false\r\n    },\r\n    \"status\" : \"success\"\r\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"
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 […]<\/p>\n","protected":false},"author":1872,"featured_media":0,"parent":12979,"menu_order":8,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13095","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13095","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1872"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=13095"}],"version-history":[{"count":23,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13095\/revisions"}],"predecessor-version":[{"id":13509,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/13095\/revisions\/13509"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/12979"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=13095"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}