GET api/serverMessages?unreadOnly={unreadOnly}

Get a list of the active server messages

Request Information

URI Parameters

Name	Description	Type	Additional information
unreadOnly	Defaults to true, only include messages unread by this user	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

List of unexpired, started server messages

Collection of ServerMessage

Name	Description	Type	Additional information
ID		globally unique identifier	None.
Created	Time when message was created	date	Data type: DateTime
CreatedBy	Account id of administrator who created message	globally unique identifier	None.
Starts	Time for message to begin appearing	date	Data type: DateTime
Subject	Message subject, default: "GaP Announcement"	string	Data type: Text
Body	Message body	string	Required Data type: MultilineText String length: inclusive between 0 and 1220
Level	Message importance level	MessageLevel	None.
Type	Message type	MessageType	None.
Expires	When to stop showing message if not deleted first	date	Data type: DateTime
GeneralServer	Indicates if this message is for the server in general or not.	boolean	None.
Updated	Last time message was updated	date	Data type: DateTime
UpdatedBy	Account id of administrator who last updated message	globally unique identifier	None.
CreatedByEmail		string	Relation. This field may not always be loaded or used for updates.
UpdatedByEmail		string	Relation. This field may not always be loaded or used for updates.
MessageLevel		string	Relation. This field may not always be loaded or used for updates.
MessageType		string	Relation. This field may not always be loaded or used for updates.
TagsDescription		string	Relation. This field may not always be loaded or used for updates.
Tags		Collection of globally unique identifier	Relation. This field may not always be loaded or used for updates.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<ArrayOfMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Tenancies.Messages">
  <Message>
    <Body>sample string 4</Body>
    <Created>2025-08-02T23:20:22.9467155+00:00</Created>
    <CreatedBy>8b1a44b8-265a-4c2d-8155-bff1e7253d01</CreatedBy>
    <CreatedByEmail>sample string 10</CreatedByEmail>
    <Expires>2025-08-02T23:20:22.9467155+00:00</Expires>
    <GeneralServer>true</GeneralServer>
    <ID>ae6fc887-a4f7-4178-a20b-3c84a90f7dbf</ID>
    <Level>5</Level>
    <Starts>2025-08-02T23:20:22.9467155+00:00</Starts>
    <Subject>sample string 3</Subject>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>06d5e3b8-7160-4e11-908f-3bf34e9db63a</d3p1:guid>
      <d3p1:guid>2ead2253-9cc7-4e48-b2bb-37be552f07e0</d3p1:guid>
    </Tags>
    <TagsDescription>sample string 12</TagsDescription>
    <Type>6</Type>
    <Updated>2025-08-02T23:20:22.9467155+00:00</Updated>
    <UpdatedBy>1e9a2654-ed8d-48c7-aba5-e9acb9ec1218</UpdatedBy>
    <UpdatedByEmail>sample string 11</UpdatedByEmail>
  </Message>
  <Message>
    <Body>sample string 4</Body>
    <Created>2025-08-02T23:20:22.9467155+00:00</Created>
    <CreatedBy>8b1a44b8-265a-4c2d-8155-bff1e7253d01</CreatedBy>
    <CreatedByEmail>sample string 10</CreatedByEmail>
    <Expires>2025-08-02T23:20:22.9467155+00:00</Expires>
    <GeneralServer>true</GeneralServer>
    <ID>ae6fc887-a4f7-4178-a20b-3c84a90f7dbf</ID>
    <Level>5</Level>
    <Starts>2025-08-02T23:20:22.9467155+00:00</Starts>
    <Subject>sample string 3</Subject>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>06d5e3b8-7160-4e11-908f-3bf34e9db63a</d3p1:guid>
      <d3p1:guid>2ead2253-9cc7-4e48-b2bb-37be552f07e0</d3p1:guid>
    </Tags>
    <TagsDescription>sample string 12</TagsDescription>
    <Type>6</Type>
    <Updated>2025-08-02T23:20:22.9467155+00:00</Updated>
    <UpdatedBy>1e9a2654-ed8d-48c7-aba5-e9acb9ec1218</UpdatedBy>
    <UpdatedByEmail>sample string 11</UpdatedByEmail>
  </Message>
</ArrayOfMessage>

text/csv

Sample:

Sample not available.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:

Sample not available.

application/vnd.ms-excel

Sample:

Sample not available.