Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimDeleteMessage
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: messages/<message_id> 

URLhttps://api.bimplus.net/v2/messages/<message_id>

Examplehttps://api.bimplus.net/v2/messages/<message_id>

Card
labelDescription
 Delete the specified message.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
messageRead
messageRead

Mark a message as "read"
Deck of Cards
idbimMessageRead
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: messages/<message_id>/markasread 

URLhttps://api.bimplus.net/v2/messages/<message_id>/markasread 

Examplehttps://api.bimplus.net/v2/messages/<message_id>/markasread

Card
labelDescription
 Mark a message as read.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created