Notice Objects

Get Notice

GET /(company_code)/v2/aol/notice/(notice_uuid)

Read notice

Get notice data including message text. If called by notice recipient, also marks notice as read.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • notice_uuid – UUID Code of notice to read
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Notice data object. Included fields depend on the role of authorized user.
  • unread_count (integer) – Number of unread notices for recipient profile
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Notice data fields

data response object has the following fields:

Field name Type Description
uuid string Notice UUID code
recipient string Mnemocode of recipient profile
timestamp string Notice date and time, ISO-formatted: YYYY-MM-DDTHH:MM:SS.mmm
category string Category code, according to lookup table
read_flag boolean Whether notice has been read by recipient
subject string Notice subject text
content_type string Message content type code, according to lookup table
body string Notice message body

Error codes used

  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted
  • request.validation.failed

See Error Codes for details.

Mark Notices As Read

POST /(company_code)/v2/aol/notice/read

Mark notices as read

Only notices sent to authorized user can be marked as read.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Request JSON Object:
 
  • notice_uuids (array) – UUID codes of notices to mark as read
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – Operation result objects
  • unread_count (integer) – Number of unread notices for recipient profile
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Operation result fields

Each object in data response array has the following fields:

Field name Type Description
uuid string Notice UUID code from request
status string Operation status, success or error
error_code string (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted
  • request.validation.failed

See Error Codes for details.