static osapi.jive.corev3.inboxEntries

Web service endpoints for interacting with notification inbox entries. See InboxEntry for an example of the JSON representation.

Example:

Perform a GET request to /inbox to get Inbox Entries for the requesting user. Here is a curl example of getting 10 unread inbox entries, retrieving only the jive field:

curl -u bobby.tables:password "http://example.jiveon.com/api/core/v3/inbox?filter=unread&count=10&fields=jive"

Methods

allRead()
POST /inbox/allRead

Retrieves

--

Description

get(options)
GET /inbox

Retrieves

InboxEntry[]

Description

Return the specified inbox entries for the person making this request. Includes a field unread that indicates the number of unread inbox entries. A collection of related inbox entries will count as one unread item as in the user interface. InboxEntry's contain a jive.collection field, which is part of a JiveExtension.

Options:
NameTypeRequiredDescription
afterStringfalseDate and time representing the minimum "last activity in a collection" to be returned. Cannot specify both after and before
authorStringfalseURI of a person, restricting returned entries to those authored by this person
beforeStringfalseDate and time representing the maximum "last activity in a collection" to be returned. Cannot specify both after and before
countIntegerfalseMaximum number of activities to return (default is 25).
fieldsStringfalseNames of the fields to be returned
typeStringfalseReturns entries of only the specified type(s) (legal values are dm, mention, and share, default is all)
unreadStringfalseFlag requesting return of unread entries only
getCounts(options)
GET /inbox/counts

Retrieves

Object

Description