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
| Field | Type | Description |
|---|---|---|
broadcast_msg_list[] | Array | List of active broadcast message objects |
broadcast_msg_list[*].broadcast_msg_title | String | Title / subject of the broadcast |
broadcast_msg_list[*].broadcast_id | Integer | Unique broadcast identifier |
broadcast_msg_list[*].broadcast_msg_desc | String | JSON string with additional details including file info: {"fileName":"...", "fileKey":...} |
status | String | OK for success |
Error Scenarios
| Scenario | HTTP | Error Code | Message |
|---|---|---|---|
Missing / invalid X-reflexis-csrf-token-X | 401 | E202 | User session is invalid |
| No broadcast messages found | 200 | NO_DATA_FOUND | No data found |
| Unexpected server-side error | 500 | E500 | Unexpected server error. |
Error Codes Reference
| Code | Description |
|---|---|
E202 | User session is invalid |
E500 | Unexpected server error |
NO_DATA_FOUND | No 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
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E202, E105, E404) |
response | string | Yes | Human-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
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E202, E105, E404) |
response | string | Yes | Human-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"
}