List active broadcast messages for the user's domain

GET /mywork/v1/broadcasts/list

Operation id: getBroadcastMessageList

Description

Retrieves active broadcast messages for the authenticated user's domain. Domain filtering is automatically applied from the session. Returns broadcast_msg_list[]. No data → NO_DATA_FOUND error (not an empty array).

Response Fields

FieldTypeDescription
broadcast_msg_list[]ArrayList of active broadcast message objects
broadcast_msg_list[*].broadcast_msg_titleStringTitle / subject of the broadcast
broadcast_msg_list[*].broadcast_idIntegerUnique broadcast identifier
broadcast_msg_list[*].broadcast_msg_descStringJSON string with additional details including file info: {"fileName":"...", "fileKey":...}
statusStringOK for success

Error Scenarios

ScenarioHTTPError CodeMessage
Missing / invalid X-reflexis-csrf-token-X401E202User session is invalid
No broadcast messages found200NO_DATA_FOUNDNo data found
Unexpected server-side error500E500Unexpected server error.

Error Codes Reference

CodeDescription
E202User session is invalid
E500Unexpected server error
NO_DATA_FOUNDNo data available

Tags: MyWorkBroadcasts

Security

  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store.

Responses

200 — Success — broadcast_msg_list array or NO_DATA_FOUND error

Content type: application/json

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Response models

200 — Success — broadcast_msg_list array or NO_DATA_FOUND error

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

Example:

{
  "status": "OK",
  "broadcast_msg_list": [
    {
      "broadcast_msg_title": "Test",
      "broadcast_id": 135239,
      "broadcast_msg_desc": "{\"fileName\":\"135239_NOTES_en_US.htm\",\"fileKey\":135239}"
    }
  ]
}

401 — Missing or invalid X-reflexis-csrf-token-X session token

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E202",
  "response": "User session is invalid"
}

500 — Unexpected server-side error

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E202, E105, E404)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E202",
    "response": "User session is invalid"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E202, E105, E404)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}