|
|
APIServer.Messages.GetMessage
| Field | Variable | ...as | Description |
|---|---|---|---|
| MessageID | Input | Input | The unique identification of the message. |
| MessageTypeID | Output | Output | The identification of the message type. The message type defines the category, severity and base text for the message. |
| ReferredMessageID | Output | Output | If the message is a sub message of another message, this is the identification of the main message. |
| MessageSessionSurrogate | Output | Output | The identification of the session that logged the message.
In some cases this surrogate can be zero. This happens when the error occurred before the session has been determined. |
| SiteKey | Output | Output | The site, which the session that logged the message belongs to.
If the session is not specified, the sitekey will be blank. |
| UserSurrogate | Output | Output | The user that was logged in to the session that logged the
message.
If the session is zero or if no user was logged into the session, this surrogate will be zero. |
| MessageDate | Output | Output | The date the message was logged. This is an ISO date. |
| MessageTimeChar | Output | Output | The time the message was logged. This is stored as a 12 character string formatted as hh:mm:ss MMM (hh=hours, mm=minutes, ss=seconds, MMM=milliseconds) |
| MessageHandled | Output | Output | Indicates whether the message has been handled by an administrator. |
| MessageCategory | Output | Output | The MessageCategory as specified by the message type. This can be System, API, Application - or any custom made category. |
| MessageSeverity | Output | Output | The severity of the message. Possible values are Information, Warning, Error, Alarm (Alarm is not used by the system - but can be specified for custom messages). |
| RequestID | Output | Output | The unique identification of the request that was being handled
when the error occurred.
You can find information about the request in the request log if it is enabled. (Global Settings). |
This API retrieves information about a message based on the message ID.
If a called function returns a message ID in the Environment<*Returned Status> field, this API can be used to retrieve more information about the error.
More information can be found by calling the GetMessageType API with the returned message type id.
The text of the message can be retrieved by calling the GetTextForMessageAPI.
Online documentation - WebsydianExpress v3.5