Bulletins - Update an bulletin

API Url

Use it for updating the bulletin.

PUT
http://localhost:16010/ProMarkREST/rest/Bulletins/bulletins/{id}

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

Path parameters

FieldTypeDescription
objectIdoptionalString

The id of the bulletin.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    bulletinsObject[]

Collection of bulletins.

      bodyString

The content of the bulletin.

      contextObject[]

Collection of data about departments/groups.

        idString

The id of department/group.

      draftLogical

True = the bulletin is just a draft.

      fromDate

From when the bulletin is active.

      previewString

A part of the bulletin.

      titleString

The title of the bulletin

      toDate

End date

      typeInteger

To whom the bulletin is addressed(0=Default, 1=Copmany, 2=Department, 3=Group).

Request example:

{
"request": {
"data": {
"bulletins": [
{
"title":" Bulletin 2",
"type":2,
"from": "2019-01-01",
"to": "2019-05-12",
"draft": false,
"preview":"The...",
"body": "The first bulletin.",
"context":[
{
"id": "MFA_AND"
}
]
}]
}
}
}

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"