ENenviance
Message

GET /ver2/MessageService.svc/messages/{messageId}

Gets a message from the Enviance User Inbox. A User may only retrieve messages from his own Inbox. Getting a message through this API does NOT mark the message as read.

SDK API: envianceSdk.messages.getMessage(messageId, onsuccess, onerror)

GET /ver2/MessageService.svc/messages/d8ac14f5-c4b1-4db2-b0fc-15452f71737d HTTP/1.1

//RESPONSE
{
  "id": "d8ac14f5-c4b1-4db2-b0fc-15452f71737d",
  "recipientId": "d2148a6f-4989-4a61-9c27-855a110f8c68",
  "sentById": "21e1f9b6-fc7c-4257-85f1-01d097762d09",
  "sentOn": "2013-06-14T14:07:52",
  "subject": "Report Completion Notification: \"Emergency Checklist Report\"",
  "body": "This is to notify you that the \"Emergency Checklist Report\" is complete.",
  "type": "EmailNotification",
  "archived": false,
  "read": false
}

envianceSdk.messages.getMessage

[
  "5bfdbd05-225f-40ee-bff1-2efe18a75375",
  "onsuccess",
  "onerror"
]

Request

Path parameters

messageIdstring required

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Response

not available

idstring guid
recipientIdOrUserNamestring
sentByIdOrUserNamestring
sentOnstring date-time
subjectstring
bodystring
typestring
archivedboolean
readboolean
sendByEmailboolean

Changes

No recorded changes to this operation across all 1 revision of this API.