Skip to main content
EMS Software, LLC

Configuring and Verifying EMS for EMS API Web Service Use

Configuring EMS for EMS API Web Service Use

External applications require a pre-defined EMS User account to authenticate to the EMS API Web Service. The EMS User account should not be granted any rights within the EMS application itself.

  1. Launch the EMS client application and login with a user that has EMS administrator-level access.
  2. Go to System Administration > Security > Users.
  3. Click the New button. The User screen will appear.
  4. Input the following information:
    • Name
    • User ID
    • Password
  5. On the Processes screen, select the Special – EMS API Web Service Access process.

Note:  If the Special – EMS API Web Service Access process does not exist, please contact Customer Support.

  1. Click the OK button.

Note:  In the Sample Code examples below, use the EMS account created in this section for the UserID and Password.

Enable JSON to Query Data

If using JSON to interface with the API, it must be enabled. (It is disabled by default).

Important!  Install must be complete before enabling JSON.

1. Edit the web.config file and enter <add key="UseJSON" value="false"/>.

2. Set the value to "true".

Verifying the EMS API

  1. Open a browser and enter the following URL:

http://[ServerName]/EMSAPI/Service.asmx (replace [ServerName] with the name of your web server)

Your browser should return a list of API calls.

The EMS API version can be verified by going to the About page:

http://[ServerName]/EMSAPI/About.aspx (replace [ServerName] with the name of your web server)