Skip to main content
Get System Messages

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

AssociateId

GetSystemMessages: Retrieves a list of system messages for a specific associate.

AssociateId
integer<int32>

Response

OK

MessageId
integer<int32>

Primary key

AssociateId
integer<int32>

The associate that is the target of this message

OnlineappId
integer<int32>

The online app that owns this message

SystemMessageId
string

Message identifier, used for message update or removal

MarkdownMessage
string

Markdown message to be displayed to user

Expire
string<date-time>

The date and time the message expires in UTC.

Type
enum<string>

Type of message, example: info, warning, error

Available options:
Unspecified,
Info,
Warning,
Error
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.