Base — shared resources#
Components used across modules. A comment on a product and on an article are the same resource.
Every resource offers the standard set of actions
get, get-by, get-all, save, update-columns, delete, delete-all —
unless stated otherwise. See the CRUD pattern.
Resources#
| Resource | Note |
|---|---|
comment |
comment — owner |
comment-thread |
comment thread |
rating |
rating — owner, receiver (the action save-reply), no update-columns |
rating-thread |
rating thread — public reading |
poll |
poll — public reading |
poll-place |
poll placement |
advert |
advertising content — public, event |
advert-place |
ad placement |
newsletter |
mailing |
newsletter-address |
subscriber |
message-thread, message, message-participant |
private messages — CRUD administrator only |
Comments#
A thread is created automatically on the first comment. A comment attaches to a thread, not directly to content.
A new comment may not be visible at once
Depending on the site it waits for approval. The write succeeds but a listing does not return it to others.
When a comment is refused (success: false, HTTP 200, reason in data.errorCode):
| Case | code |
errorCode |
|---|---|---|
| the thread of a discussion post whose author switched comments off | 607 |
commentsClosed |
| a guest comments on a discussion post and the site allows comments only from signed-in users | 400 |
commentOnlyForLoggedIn |
| a new comment with an e-mail or IP address on the blacklist | 615 |
blacklisted |
Ratings#
A rating thread carries computed summaries — the count, the average and the star breakdown.
The summaries are stored values
They are recalculated when a rating changes. A brief mismatch with individual reviews is normal.
A reply to a rating#
The action save-reply writes the operator's reply to a rating. The owner of the rated
profile may call it (role receiver). The author of the rating may not reply and the role
owner does not help: it no longer allows anything on this action. The author edits only
their own rating (save).
Private messages#
The resources message-thread, message and message-participant are for an
administrator only over HTTP. Actions on one conversation — read messages, reply, mark
read, hide, list participants — and the "my" listings are internal: the site calls them
but they have no HTTP wrapper, so they are unavailable from an external client.
Who is owner and who receiver in a conversation
owner is the one who wrote at least one undeleted message in the conversation,
receiver the one to whom a message came. After the first reply each side is both.
Polls#
Voting has an internal action with no HTTP wrapper.
You cannot vote through the API
Reading a poll, yes; casting a vote, no.
Newsletter#
An address added through the API must still be confirmed
Adding an address is not consent to a mailing. An unconfirmed address is not mailed — and that is correct.