REST API

The REST API provides developers with a Web Application Programming Interface (Web API) based on the Representational state transfer (REST) software architectural style.

The following web.config application settings are used to configure the REST API:

Other web.config settings are required to use the REST API (see required for REST API comments in the released version of this file):

The REST API can be tested using utilities such as:

• The Postman desktop app.
• The HttpRepl command-line tool.

In the following API documentation, SISfm is the SISfm URL, and the request body and response data are in JSON format.

Map Compiler API

The Map Compiler desktop edition uses SISfm/api/MC when its UploadAuthTokenUrl setting is defined, to get details from a remote SISfm website, and to post compiled files to it.

Database API

GET SISfm/api/data

• Description:
  • Select rows from a database table.
• Parameters:
  • fields - comma-separated list of the names of fields to include, default all fields
  • table - table name.
  • where - SQL WHERE clause, default 1<>1.
• Body:
  • (not required)
• Responses:
  • 200 OK
    [{"field1":"value1",...},...]
  • 400 Bad Request
    {"error":"message"}
• Examples:
  • GET http://domain/SISfm/api/data?fields=name,description&table=site&where=site_id='20'
• Notes:
  • Field names may be expressions supported by the database SQL..

POST SISfm/api/data

• Description:
  • Insert a row into a database table.
• Parameters:
  • table - table name.
• Body:
  • {"field1":"value1",...}
• Responses:
  • 200 OK
  • 400 Bad Request
    {"error":"message"}
• Examples:
  • POST http://domain/SISfm/api/data?table=site
    {"site_id":"'55'","name":"'Test Site'"}