Service Announcements

Occasionally service messages are broadcast to all users of the system. On the TransPDF website these messages appear at the top of every page until dismissed by the user. They may contain notices of pending service interruptions and price changes.

URL: /segments/get_sys_messages/
Post Data: session_id

session_id

The unique key returned in the initial login call.

Returns

On success, a JSON structure containing messages.
On failure the HTTP status code will be set to something other than 200.

The JSON structure will contain a list of the following fields:

id

The id of the message. Use this to dismiss messages.

title

The title of the message

message

The body text of the message. This may contain HTML.

URL: /segments/dismiss_sys_message/
Post Data: session_id, msg_id

session_id

The unique key returned in the initial login call.

Returns

On failure the HTTP status code will be set to something other than 200.

If successful, the message will never be delivered again to the user.