Notice details
Read your projected notices
/a/Notice_getRequestedDetails
Retrieve mapped notices addressed to the authenticated user.
When to use this endpoint
Use for selected notice details; it does not mark them read or reproduce the bell’s current-message filters.
Authentication and permissions
Use signed API-key authentication or a logged-in CRM session on the account’s routed host. API keys act as their owner; normal session requests need dispatcher CSRF protection where configured. Tenant data is selected from the authenticated account.
The handler has no additional page-action/Role check. A CRM2 screen hiding a control does not add such a server guard, and CRM2 role names must not be assumed to apply to CRM1. The dispatcher has no dedicated object-scope mapping for this namespace.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id / ids | Integer-compatible scalar or native list | No | id takes precedence. Positive record IDs are the normal selection. Scalars integer-convert; encoded JSON list text is not decoded. On mapped details, omission or an empty native list adds no ID restriction, so supply another bounded filter deliberately. |
fields | Native list of mapped names | No for details; required for tables | Details default to all mapped fields. Unknown names are omitted; id is always included. JSON-encoded list text is not decoded. Whole JSON/text columns remain encoded strings, while nested metadata projections can decode values. |
Notice filters | Mapped values | No | id,subject,body,status,userID,cDate,cDateUnix,dueDate,meta,originalID,sDate,metaCreatedBy,metaIsImportant. userID is always replaced with the actor. cDate projects database FROM_UNIXTIME; cDateUnix/dueDate/sDate are raw integer seconds. |
Mapped filters / order / advanceSearch | Scalars, native lists or structured query controls | No | Mapped filters combine with AND; lists use IN. Detail text filters are trimmed case-insensitive exact matches; table text filters use substring LIKE. Detail order accepts mapped names or {id,dir} descriptors. Structured comparisons use mapped columns, condition/value and optional andOr/special. These legacy wrappers do not add a strict query-control allowlist; raw advanced conditions are a trusted UI surface, not an integration SQL interface. |
Example request
$result = FM_api('Notice_getRequestedDetails', ['id'=>['18'],'fields'=>['id','subject','status','userID']]);
Example response
[
{
"id": "18",
"subject": "Please review",
"status": "0",
"userID": "37"
}
]
Application errors normally remain JSON responses with HTTP 200; inspect error/warning keys. Numeric driver values can be strings.
Errors and unusual responses
| Response | Condition |
|---|---|
{"error":"not logged in"} | No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs. |
Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.
Behaviour and edge cases
- Returns a bare row array for mapped details, not a single object; empty results are []. Whole metadata columns remain encoded strings. Database scalar types remain driver-dependent. The detail helper can also turn a failed database read into [], so it is not a distinct read-failure signal.
- The actor filter overrides a supplied userID. Other mapped filters still apply, but no implicit status, due-date, future-message or meta.source=push exclusion is added. This is distinct from bell/list filters; it can include your Push-source notices.
- No pagination, maximum row count or default order. Whole meta remains encoded JSON; nested metadata projections can decode values.
Side effects
- Reads notices only; no seen timestamp, status change, push, email or acknowledgement.
See it in Fieldmotion
CRM1
No direct exact-route caller found; the bell uses Notice_get/checkNew.
CRM2
No direct current CRM2 caller to this exact route was found. The bell uses other Notice readers; do not assume their status/source filters apply here.
Related endpoints
Notice_get— Continue the related read/write workflow.Notice_checkNew— Continue the related read/write workflow.Notice_markSeen— Continue the related read/write workflow.