GET Message Folders

Developer Tools

GET api/v1/{EMRSystem}/MessageFolders

Returns the EMR inbox message folders for a given user.

HTTP Method

GET

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

In Dev

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

Gets or sets the user identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing a collection of Message Folders.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

FolderId

Gets or sets the folder identifier.

string

None.

FolderName

Gets or sets the folder name.

string

None.

MessageCount

Gets or sets the message count.

integer

None.

UnreadCount

Gets or sets the unread message count.

integer

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.MessageFoldersResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.

 
Response Formats
Sample Message
Download Json Schema
[
  {
    "FolderId": "sample string 1",
    "FolderName": "sample string 2",
    "MessageCount": 3,
    "UnreadCount": 4
  },
  {
    "FolderId": "sample string 1",
    "FolderName": "sample string 2",
    "MessageCount": 3,
    "UnreadCount": 4
  }
]
Sample Message
<ArrayOfMessageFolderViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <MessageFolderViewModel>
    <FolderId>sample string 1</FolderId>
    <FolderName>sample string 2</FolderName>
    <MessageCount>3</MessageCount>
    <UnreadCount>4</UnreadCount>
  </MessageFolderViewModel>
  <MessageFolderViewModel>
    <FolderId>sample string 1</FolderId>
    <FolderName>sample string 2</FolderName>
    <MessageCount>3</MessageCount>
    <UnreadCount>4</UnreadCount>
  </MessageFolderViewModel>
</ArrayOfMessageFolderViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?