Bulletins - Get all bulletins.

API Url

Use it for returning the bulletins.

GET

http://localhost:16010/ProMarkREST/rest/Bulletins/bulletins

Permissions: user

Query parameters

Field	Type	Description
date`optional`	Date	Date of the bulletin. Defaul = TODAY.
deptId`optional`	String	List of departments (separated by ',').
expand`optional`	Logical	TRUE = show the body of the bulletin(HTML).
fields`optional`	String	Fields to show.
groupId`optional`	String	List of groups (separated by ',').
includeInactive`optional`	Logical	TRUE = include also the inactive bulletins.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
bulletins	Object[]	Collection of bulletins.
body	String	The content of the bulletin.
changed	Date	The date when the bulletin was last time changed.
changedBy	String	The id of the user who last changed the bulletin.
context	Object[]	Collection of data about departments/groups.
desc	String	Description of department/group.
id	String	The id of department/group.
draft	Logical	True = the bulletin is just a draft.
from	Date	From when the bulletin is active.
id	Integer	The id of the bulletin.
preview	String	A part of the bulletin.
title	String	The title of the bulletin
to	Date	End date
type	Integer	To whom the bulletin is addressed(0=Default, 1=Company, 2=Department, 3=Group).
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "bulletins": [{
               "id": 2163334059,
               "title": " Bulletin 1",
               "type": 2,
               "from": "2019-01-01",
               "to": "2019-05-12",
               "draft": false,
               "preview": "The...",
               "changed": "2019-02-14",
               "changedBy": "MVE",
               "context": [{
                  "id": "MFA_AND",
                  "desc": "Warehouse Transport & Spedition"
               }]
            },
            {
               "id": 2163333857,
               "title": " test 1/28 48 ",
               "type": 1,
               "from": "2019-01-01",
               "to": "2019-04-12",
               "draft": false,
               "preview": "test ghjjkjkljhgfd dfsafds fds fds fdsafdsa",
               "changed": "2019-02-14",
               "changedBy": "TSA"
            }
         ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
errorCode	Number	Error code.
errorMessage	String	Error description.