Quercus Message Link Developer’s Guide<>

Enabling Message Link web services

The QML.REST.ENABLED parameter

To enable Message Link web services

1Set the QML.REST.ENABLED parameter to TRUE.

The parameter value can be changed through the Control Centre Set-up | Parameters option.

2Verify that the Web Service is active.

You can verify that the message link web service is active by pinging the service using a URL like:

https://<servername.domain>/<DAD>/qml_rest.ping
https://labs.campusit.net/qdev/qml_rest.ping

Note: your URL will be different but the common element is the Ping function qml_rest.ping

If the service is enabled the following response will be returned:

To disable Message Link web services

1Set the QML.REST.ENABLED parameter to FALSE.

2Verify that the Web Service is no longer active.

If the Message Link web service is not enabled then the following response will be returned to a ping.

When the interface is disabled all requests to the service will end with a HTTP 404 Page Not Found error.

The QML.REST.ACCESS_ID parameter

To send, receive and delete messages using Quercus Message Link Web Services an access ID is required. This is the most basic security option available in Quercus Message Link. It is affectively an identifier that you must pass in any calling URL. The access ID that you pass in the URL must match the one that is stored in the database.

The parameter value can be changed through the Control Centre Set-up | Parameters option:

Any service requests to the message link services must contain the Access ID as a parameter:

Example

https://labs.campusit.net/qdev/qml_rest.ReceiveMessage?accessid=GIVE_ME_ACCESSS
 

Note the parameter accessid= in the URL. The value of this must match the value stored in the database. Requests without a valid Access ID are rejected with a Forbidden (HTTP 403) error.