IPrimeSuiteAPI REST API Documentation

MessageListGet

Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Messaging/MessageListGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MessageListGetRequest>
  <Folder>1000</Folder>
  <PageSize>0</PageSize>
  <PageStart>0</PageStart>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
</MessageListGetRequest>

Request Json Example (schema):

{
  "Folder": 1000,
  "PageSize": 0,
  "PageStart": 0,
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MessageListGetResponse>
  <MessageList>
    <Body>String Content</Body>
    <Folder>0</Folder>
    <FromUserName>String Content</FromUserName>
    <FullName>String Content</FullName>
    <FromUserID>0</FromUserID>
    <MessageID>0</MessageID>
    <MessageRecipient>
      <Recipients>
        <RecipientID>0</RecipientID>
        <DisplayText>String Content</DisplayText>
        <Type>String Content</Type>
        <Name>String Content</Name>
      </Recipients>
    </MessageRecipient>
    <PatientID>0</PatientID>
    <Priority>0</Priority>
    <ReadStatus>0</ReadStatus>
    <ReceivedDate>0001-01-01T00:00:00</ReceivedDate>
    <Subject>String Content</Subject>
    <Type>0</Type>
    <TypeDescription>String Content</TypeDescription>
  </MessageList>
  <TotalRows>0</TotalRows>
</MessageListGetResponse>

Response Format: Json

Response Example (schema):

Could not generate example for response. Failed with error: Specified cast is not valid.