Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: Message.GetReferringMessages

Scoped Name

APIServer.Messages.GetReferringMessages

Interface

Field Variable ...as Description
ReferredMessageID Position Input The unique identification of the message for which you want to find all related messages. This restricts the list and is a mandatory input field.
MessageDate Position Input The date the message was written to the log.
MessageTimeChar Position Input The time the message was written to the log. This is a character string with the format hh:mm:ss MMM (hh=hours, mm=minutes, ss=seconds, MMM=milliseconds).
Position Control Input Specifies whether the list of record should be positioned by the values specified in the Position variable.
RowsFetched Control Dual The number of rows fetched.
MessageID FetchedData (64) Output The unique identification of a referred message.
MessageTypeID FetchedData (64) Output The message type for the referred message.
ReferredMessageID FetchedData (64) Output The identification of the message the referred message refers to.
MessageSessionSurrogate FetchedData (64) 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 FetchedData (64) Output The site the referred message belongs to.
UserSurrogate FetchedData (64) Output The identification of the user that was logged in to the session that wrote the referred message to the log. If no user is specified, the session was anonymous.
MessageDate FetchedData (64) Output The date the referred message was written to the log.
MessageTimeChar FetchedData (64) Output A character representation of the time the referred message was written to the log.

This is a character string with the format hh:mm:ss MMM (hh=hours, mm=minutes, ss=seconds, MMM=milliseconds).

MessageHandled FetchedData (64) Output An indication of whether the referred message has been marked as handled in the administration interface.
Message Category FetchedData (64) Output The category of the referred message.
MessageSeverity FetchedData (64) Output The severity of the referred message
RequestID FetchedData (64) 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).

Description

When messages are written to the message log, it is possible to create one main message (e.g. "Validation Error") and then create a number of sub messages that explains each thing that has gone wrong in the validation. This API makes it possible to retrieve all sub messages for a specific main message.

Events

Universal events