ProRoster - Add demand notes

API Url

Used for inserting one or more notes on a plan demand.

POST
http://localhost:16010/ProMarkREST/rest/ProRoster/demands/{id}/notes

Permissions: user

Path parameters

FieldTypeDescription
Number

id The id of the plan demand.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    notesObject[]

Collection of notes.

      isEmpNoteBoolean

TRUE if the note is to be sent to the employee.

      textString

The message itself.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    notesObject[]

Collection of notes.

      idNumber

Unique ID of the note.

      isEmpNoteBoolean

TRUE if the note is to be sent to the employee.

      textString

The message itself.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"notes": [
{
"id": 123456789,
"text": "Please remember to log time",
"isEmpNote": true
}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.