Change Message status (unread, read, approve)

Overview

• approve/reject Message
  • When the message type to be approved is message
    change message status to read/unread
  • When the type of the message to approve is request
    • When the RequestType is relation.add/relation.remove
      According to the value of the message, link/unlink Relation and ExtCell and change the state of the message to approve/reject
    • When the RequestType is role.add/role.remove
      According to the value of the message, link/unlink Role and ExtCell and change the state of the message to approve/reject
    • When the RequestType is rule.add/rule.remove
      According to the value of the message, create/delete the Rule and change the state of the message to approve/reject

Required Privileges

message

Requires additional privilege when the type of the message is request.

RequestType	Required Privilege
relation.add relation.remove role.add role.remove	social
rule.add rule.remove	rule

Restrictions

• Always handles Content-Type in the request header as application/json
• Only accepts the request body in the JSON format
• Only application/json is supported for Content-Type in the request header and the JSON format for the response body
• Response body data is not ensured if atom or xml is specified in the $format query option, although it does not result in an error

Request

Request URL

{CellURL}__message/received/{MessageID}

Request Method

POST

Request Query

Query Name	Overview	Effective Value	Required	Notes
p_cookie_peer	Cookie Authentication Value	The cookie authentication value returned from the server during authentication	No	Valid only if no Authorization header specified Specify this when cookie authentication information is to be used

Request Header

Header Name	Overview	Effective Value	Required	Notes
X-HTTP-Method-Override	Method override function	User-defined	No	If you specify this value when requesting with the POST method, the specified value will be used as a method.
X-Override	Header override function	${OverwrittenHeaderName}:${Value}	No	Overwrite normal HTTP header value. To overwrite multiple headers, specify multiple X-Override headers.
X-Personium-RequestKey	RequestKey field value output in the event log	Single-byte alphanumeric characters, hyphens ("-"), and underscores ("_") Maximum of 128 characters	No	When not specified, default value given with ${4 digits}_${22 digits} Base64url characters format representing an UUID for each request
Authorization	Specifies authentication information in the OAuth 2.0 format	Bearer {AccessToken}	No	* Authentication tokens are the tokens acquired using the Authentication Token Acquisition API
Content-Type	Specifies the request body format	application/json	No	[application/json] by default
Accept	Specifies the response body format	application/json	No	[application/json] by default

Request Body

JSON

Item Name	Overview	Effective Value	Required	Notes
Command	Message Command	When Type is message read: read unread: unread When type is request approved: approved rejected: rejected However, if you have already changed to approved or rejected, you can not approve it	Yes

Request Sample

{"Command": "approved"}

Response

Response Code

204

Response Header

Item Name	Overview	Notes
ETag	Resource version information
DataServiceVersion	OData version
Access-Control-Allow-Origin	Cross domain communication permission header	Return value fixed to "*"
X-Personium-Version	API version that the request is processed	Version of the API used to process the request

Response Body

None

Error Messages

Refer to Error Message List

cURL Command

curl "https://cell1.unit1.example/__message/received/c87b42e10df846a9bee842225d1383fe" -X POST \
-i -H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H 'Accept: application/json' \
-d '{"Command": "approved"}'