Inbox API

List Messages

Current Implementation

Retrieves the messages of a particular User. Messages can be retrieved from different sources. Currently supported sources are: Email, Alert or Document.

Archived or Trashed messages are never returned.

Parameters

Base URL: /getMessages

Parameters:

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
type	ENUM	No	Possible values: ['ALL', 'ALERT', 'EMAIL', 'DOCUMENT' ]. Default value: "ALL". The source of the messages.
location	ENUM	No	Possible values: ['INBOX', 'SENT', 'ARCHIVE']. Default value: "INBOX".
patientId	String	No	Used if we want to retrieve only those messages related to a specific patient.

API Sample

curl 'http://192.168.2.102:8080/PresentationServices/getMessages?type=Alert&location=INBOX&userId=poda&token=d2360c39-637b-41da-988d-f031db5affbb&_=1395133673255' -H 'Accept: application/json, text/javascript, */*; q=0.01' -H 'User-Agent: Mozilla/5.0 (Linux; Android 4.4.2; Nexus 5 Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/30.0.0.0 Mobile Safari/537.36' --compressed

Result

{

"messagesFact": {

"statusFact": {

"success": true

}

,"messageObjects": [

{

  "messageId": "25",

  "type": "Alert",

  "podId": "Pod C",

  "location": "INBOX",

  "labels": [],

  "messageDate": "3/07/14",

  "messageTime": "13:26",

  "description": "No Skin To Skin Contact In 7 Days",

  "from": "[S4-ALERT] No skin to skin contact in 7 days",

  "title": "            peggy 501##split##33wks 998g",

  "payload": "This patient has not had skin to skin contact for at least 7 consecutive days.",

  "status": "Unread",

  "priority": "HIGH",

  "tasksCount": 1,

  "tasksComplete": 0

},{

  "messageId": "22",

  ...

  }

 ]}}

Inbox API

Table of Contents

List Messages

Current Implementation

Parameters

API Sample