Install the EMS Master Calendar API Web Service

Once you meet the prerequisites, to install EMS Master Calender API, you will:

• Obtain the installation files

• Install/upgrade the database component in EMS Master Calendar

• Install/upgrade the EMS Master Calendar API Web Service

• Configure EMS Master Calendar for Master Calendar API Web Service Use

• Verify the Master Calendar API

Obtain the Installation Files

Contact your Professional Services Consultant or Customer Support to obtain the following components:

1. Master Calendar API (MCAPI.msi) – Installation file.

2. MCAPI_Script.sql – This SQL file is required to create the necessary API objects within your Master Calendar database.

Install/Upgrade the Database Component in Master Calendar

1. Obtain the MCAPI_Script.sql file.

2. Open Microsoft SQL Server Management Studio.

3. Within Microsoft SQL Server Management Studio, select File > Open > File. Locate the MCAPI_Script.sql file.

4. Select your Master Calendar database and execute the query (Query > Execute).

   When the query execution has completed, a ‘Commandcompleted successfully’ message displaysin the Results section.

Install/Upgrade the Master Calendar API Web Service

Before beginning the installation process, please install or upgrade your Master Calendar databases as outlined in the Master Calendar Installation Instructions. You will also need to manually uninstall any previous versions of the Master Calendar API Web Service on your web server.

1. Download the MCAPI.msi file onto the web server that will be running the Master Calendar API Web Service (typically the web server that hosts your Master Calendar site.)

2. Run MCAPI.msi.

   A Welcome Screen to the Master Calendar API Setup Wizard opens.

3. Click Next to begin the installation process.

   The Destination Folder screen opens.

4. Select the destination folder.

   The installation process creates a new physical directory on your web server based on the destination folder path entered (“MCAPI” in the example above.)

   Do not install the Master Calendar API Web Service in the same physical directory as other EMS web-based products OR under a site running another version of Master Calendar or the Master Calendar API.

5. Click Next.

   The SQL Server and database information screen opens.

6. Enter your Master Calendar SQL Instance Name.

7. Enter your Master Calendar Database Name.

8. Click Next.

   The Virtual Directory information screen opens.

9. The Virtual Directory Name defaults to the destination folder. We recommend that you keep the default setting. The installation process creates a virtual directory on your web server based on the virtual directory entered (“MCAPI” in the example above.)

   The Master Calendar API Web Service should not be installed in the same virtual directory as other EMS web-based products OR under a site running another version of Master Calendar or the Master Calendar API.

10. Click Next.

    The Ready to install Master Calendar API screen opens.

11. Click to install the Master Calendar API Web Service.

    The Completed the Master Calendar API Setup Wizard screen opens.

12. Click Finish.

Configure Master Calendar for Master Calendar API Web Service Use

External applications require a pre-defined Master Calendar User account to authenticate to the Master Calendar API Web Service. The Master Calendar User account should not be granted any rights within the Master Calendar application itself. Please see the Master Calendar Configuration Guide for instructions on how to create a Master Calendar user account.

In the Sample Code examples below, use the Master Calendar account created in this section for the UserID and Password.

Verify the Master Calendar API

1. Open a browser and enter the following URL:
   http://[ServerName]/MCAPI/MCAPIService.asmx
   (replace [ServerName] with the name of your web server)

2. Your browser should return a list of API calls.