Events API v1
Event Management Endpoints
Here is the order of the essential messaging services:
| Service | Input Parameters | Response Fields | Status | |
| 1 | Events/Register | subscriber name(your choice/reference no.) | Subscriber ID | You are now a registered Subscriber. |
| 2 | Events/Subscribe | subscriber ID from above, Comp code(GF), topic(n-nnn) | Null* | You now have a mailbox set up. |
| 3 | Events/Peek | subscriberId, timeout period ** | Message count, Next message ID. *** | You now have the message ID. |
| 4 | Events/Receive | subscriberid, messageid, locktimeout | Message Body | You now have your message. |
| 5 | Events/Confirm | subscriberid, messageid, lockid | Message Id | Your message has now been removed from the queue. |
Notes
* Please note that even null responses receive a Response Code. The code sent for a correct web service call is 200, any other response code requires investigation. For a full list of response codes please see this page Link .
** A time out period can be sent by the caller. The default period is 90 seconds and this cannot be exceeded. We recommend setting a time out period of around 60 seconds.
*** If no messages are available when the request is made and no messages become available before the timeout period is reached, a timeout response will be sent. At this point a new ‘Peek’ request should be made by the client. It is this cycle of Peek, timeout, peek, timeout, peek, message, peek that ensures events are received in real time.
Other Event Endpoints
Events\ViewSubscriptions – return a list of active mailboxes for the given subscriber ID
Events\Unsubscribe – deletes a mailbox. It is important that this step is undertaken when messages are no longer wanted, failure to do so will result in a backlog of messages.
Events\ViewTopics – returns a list of available topics.
Events\Publish – for future use, not currently active. Enables the publication of events to the message Queue.
Long Polling Sequence Diagram
The diagram below gives a visual representation of the services needed to be called in order to set up a mailbox, Peek messages and Pop them from the queue.
