Icon Web Server Native Modules API

The server native modules API requests use a REST-ful style that is structured as follows:

<Origin>/modules/<Module>?<Parameters>

<Origin> = <Protocol>://<Domain>[:<Port>]

<Module> = Native server module name

<Parameters> = URL parameters in key=value form and an
               ampersand (&) between parameters

Information The "modules" resource name is the default resource name for native server module requests. The module resource name is configurable in the web server. Please make sure that the resource name that you are using matches the proper resource name on the target web server.

Any content included with native server module API requests, or returned as a response to the request, should/will be formatted as JSON content. The date/time format used in the JSON content is equivalent to a raw JavaScript Date value: an integer value representing the number of milliseconds since 1 January 1970 UTC.

Information Any forward slashes present in any JSON content returned as a response by the native server module API will be escaped so that the JSON content can be included in HTML without issues.


Execute Module Request
The execute module request executes the native server module specified in the URL, passing in any subsequent path information or parameters included in the rest of the URL. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: Any valid HTTP method

HTTP Request Content Type: Any valid content type
HTTP Response Content Type: Any valid content type

Example Request:

PATCH https://localhost/modules/musiccollection/3e02ea43-f185-473a-9400-475af51f73bc/5

Example Request Content:

{
   "MediaID": "SJSuBMrDMpo"
}

HTTP Response: Any valid HTTP status code
Image