Introduction

This document describes the Smart Event Manager Application Programming Interface (API). The API provides methods for manipulating data in Smart Event Manager.

The API is subjected to further development and extra features might be added based on practice and requirements. Please, feel free to contact us if you need methods which are not provided at this moment of time.

Requirements

  • Smart Event Manager Web Application

  • A license to use the API

  • An account with permissions to log on to the API

Version Control

Since the API might change between different versions of Smart Event Manager, always check whether this documentation corresponds to the API version being used. The version of this documentation can be found next to the assembly name of the topic concerning classes. To check which version of Smart Event Manager is being used, call the TestConnection function and read the version number from the response. We will strive to keep future versions of the API backwards compatible while new functionality is being added.

URL

The Smart Event Manager API is a Web Service that can be reached at a defined location. The 'myorganizationid' should be set to connect to the environnement of the customer.

C#
https://myorganizationid.smarteventmanager.com/api/

Communication

The API enforces a secure SSL (HTTPS) connection.

The communication with this API is based on the HTTP/HTTPS standard. That means the following http-methods can be used.

Action

Http method

Retrieve data

GET

Add data

POST

Update data

PUT

Delete data

DELETE

For the response the common HTTP response codes are used. For example:

Response code

Description

200

OK

201

Created

400

Bad request

401

Unauthorized

404

Not found

500

Internal server error

...

Etc.

Content Types

For communication with the API 3 different content types can be used.

  • Form urlencoded

  • Json

  • Xml

There is a seperate topic about the content types.

Models and Controllers

To communicate with the API, requests to the controllers can be made. All controllers described in this document can be reached relative from the root location in the following way.

C#
https://myorganizationid.smarteventmanager.com/api/{Controller}/{Action}/
Every action can be called by firing a request to it while specifying the required parameters in the model.

Data types

Different data types can be set in the model of http request messages.

Data type

Example

Notes

String

"Example of a string"

String values must be surrounded by (single or double) quotes.

Integer

12345

Integer values do not need to be surrounded by quotes, but can if you prefer. Both single and double quotes are allowed.

Date

2012-07-27T18:51

Date should be set in the ISO 8601 format. Since it is not necessary to specify all positions of this format, it is advised to pass date in the aforegoing format.

Correlation

When multiple requests to the API are fired and multiple responses are received, somehow a match between the request and response must be made. This is the reason why a CorrelationID can be set in each request. The server will always respond with the same CorrelationID of the corresponding request. Normally a GUID will be set but this is not compulsory.

Setting the CorrelationID is optional, it can be ommitted from the request model if there is no need for it.