Mention

Mention Service

Web service endpoint for mentions.

Get Mention

GET /mentions/{mentionID}

Return the specified mention.

Path Parameters:
NameTypeRequiredDescription
mentionIDStringtrueID of the requested mention
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Return Status:
HTTP Status CodeDescription
200 (OK)Request was successful
400 (Bad Request)An input field was malformed
403 (Forbidden)You are not allowed to access this mention
404 (Not Found)The specified mention does not exist

Mark Read

POST /mentions/{mentionID}/read

Mark the specified mention as having been read.

Path Parameters:
NameTypeRequiredDescription
mentionIDStringtrueID of the mention to be marked
Return Status:
HTTP Status CodeDescription
204 (No Content)Request was successful
400 (Bad Request)An input field was malformed
403 (Forbidden)You are not allowed to access this mention
404 (Not Found)The specified mention does not exist

Mark Unread

DELETE /mentions/{mentionID}/read

Mark the specified mention as having not been read.

Path Parameters:
NameTypeRequiredDescription
mentionIDStringtrueID of the mention to be marked
Return Status:
HTTP Status CodeDescription
204 (No Content)Request was successful
400 (Bad Request)An input field was malformed
403 (Forbidden)You are not allowed to access this mention
404 (Not Found)The specified mention does not exist