Discover more about the announcement object and its related properties
Table of Contents
Introduction
In ConstructionOnline, announcements serve as a way for users to post critical information company-wide or for a specific project that an entire team can view, but not respond to. Announcements can be made to instantly notify project teams of schedule changes, meeting updates, important reminders, or convey any information that doesn't require immediate feedback or discussion.
Announcement Object
The announcement object represents an individual announcement in ConstructionOnline. Each announcement object returns multiple properties that reveal specific details about the announcement, such as its title, message, and priority level.
Each announcement object is referenced by a unique numerical ID, which is stored in the property 'ID'. An announcement's ID is automatically assigned during creation and cannot be modified. To update, return, or delete a specific announcement, you must know the announcement's ID. Each announcement object will contain at least a 'TITLE', as this property is required for creation. The remaining announcement object properties are optional. Some properties cannot be added or edited using the API and can only be manually updated from ConstructionOnline.
| Name | Type | Description |
| ID | integer | Unique identifier for the announcement. This property cannot be manually updated or assigned. |
| PRJ_ID | integer | Unique identifier for the project the announcement was posted in. |
| TITLE | string | Title/subject line of the announcement. |
| MESSAGE | string | Body/message of the announcement. If the message contains any HTML formatted text, such as bolded letters or special characters, the returning string will be encoded. |
| PRIORITY | integer | Priority status of the announcement. A status of "None" will return 0, "Low" will return 1, "Medium" will return 2, and "High" will return 3. |
| LMOD | string | Date and time the announcement was last modified. This property cannot be manually updated or assigned. |
| LMOD_USER | integer | Unique identifier for the user who last modified the announcement. This property cannot be manually updated or assigned. |
| DATE_CREATED | string | Date and time the announcement was originally created. This property cannot be manually updated or assigned. |
| CREATED_BY | integer | Unique identifier for the user who originally created the announcement. This property cannot be manually updated or assigned. |
| PINNED | boolean | Signifies whether or not the announcement was pinned. If the announcement was pinned, the value will return as True. If not, the value will return as False. |
| PROJECT_NAME | string | Name of the specified project, which corresponds to the announcement's assigned PROJ_ID. This property cannot be manually updated or assigned. |
| ATTACHIDS | string | File ID and TinyURL for each attachment uploaded to the announcement. This property cannot be manually updated or assigned. |
| ATTACHMENTS | string | File ID, name, extension, TinyURL, size, image height, image width, date/time created, user created by, and date/time last modified for each attachment uploaded to the announcement. This property cannot be manually updated or assigned. |
{
"ID" = 67795,
"PRJ_ID": 1114693,
"TITLE": "Weather Delay - 1/9",
"MESSAGE": ""<p>Due to severe weather in the area, work has been canceled for the rest of the day.</p>",
"PRIORITY": 3,
"LMOD": "2024-01-09T19:17:00.047",
"LMOD_USER": 29,
"DATE_CREATED": "2024-01-09T19:17:00.047",
"CREATED_BY": 29,
"PINNED": true,
"PROJECT_NAME": "450 Ogletree Rd",
"ATTACHIDS": "{18251183,NMGH4CLA63X.png},{18251185,PATXX6JACNE.jpg}",
"ATTACHMENTS":"[{\"FILE_ID\":18251183,\"NAME\":\"surface_pro_bg\",\"EXT\":\".png\",\"TINYURL\
":\"NMGH4CLA63X\",\"SIZE\":59174,\"IMGHEIGHT\":1080,\"IMGWIDTH\":1920,\"DATE_CREATED\
":\"2023-08-14T19:16:53.843\",\"CREATED_BY\":29,\"LMOD\":\"2023-08-14T19:16:53.870\"},
{\"FILE_ID\":18251185,\"NAME\":\"sub_75px\",\"EXT\":\".jpg\",\"TINYURL\":\"PATXX6JACNE\",
\"SIZE\":3234,\"IMGHEIGHT\":75,\"IMGWIDTH\":75,\"DATE_CREATED\":\"2023-08-14T19:16:54.027\",
\"CREATED_BY\":29,\"LMOD\":\"2023-08-14T19:16:54.030\"}]"
}
Endpoints