Skip to content

Query multiple EviNotices

Request

Use State Closed to find notices that have reached the only terminal state. Outcome then identifies the final recorded result. A notice can close with Outcome Received when link access was recorded and no higher-priority outcome applies.

Security
basicAuth
Bodyapplication/json
Limitinteger, [ 1 .. 100 ]

Maximum number of results to return per page.

Default:100
Ownerstring, (email)

Without Owner, site-level users see their site and other users only their own notices. Owner filtering is allowed only for site-level users (403 otherwise), and must be a valid email (400 otherwise). Drafts are excluded.

LookupKeysArray of strings

Filter by one or more integrator-assigned lookup keys.

LinkedIdstring, (uuid)

Filter by linked ID.

Statestring

Filter by current notice state. Use Closed to select notices with a final outcome.

Enum:"Draft""Submitted""Processed""Sent""Dispatched""Delivered""Received""Read""Replied""Closed"
Outcomestring

Filter by outcome. None selects open notices. Received selects closed notices whose final outcome records link access.

Enum:"None""Certified""Sent""Delivered""Received""Read""Accepted""Rejected""Failed""Refused"
Cursorstring

Opaque pagination cursor returned in the previous response. Pass this value to retrieve the next page.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v2/EviNotice/Query \
  -H 'Content-Type: application/json' \
  -d '{
    "Limit": 100,
    "Owner": "user@example.com",
    "LookupKeys": [
      "string"
    ],
    "LinkedId": "5b64f22c-bd29-4d24-affe-e0bd94d5c0e9",
    "State": "Draft",
    "Outcome": "None",
    "Cursor": "string"
  }'

Responses

Query executed successfully

Bodyapplication/json
Cursorstring

Returned whenever the page contains results, including the final non-empty page. Continue until the response has no results; that empty response has no Cursor.

ResultsArray of objects(EviNoticeSummary)

The list of EviNotice summaries matching the query.

Response
{ "Cursor": "AQAAAADFDwwAAAAAABVOhADim0HUo3Jm+wAAAAAAAAA=", "Results": [ { … } ] }