IPrimeSuiteAPI REST API Documentation


MessageSend


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<MessageSendRequest>
  <Message>
    <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>
  </Message>
  <PatientInfo>
    <PatientID>0</PatientID>
    <ResidentialAddress>
      <AddressID>0</AddressID>
      <Country>0</Country>
      <CountryName></CountryName>
      <AddressLine1>String Content</AddressLine1>
      <AddressLine2>String Content</AddressLine2>
      <City>String Content</City>
      <PostalCode>String Content</PostalCode>
      <State>0</State>
      <StateString></StateString>
      <County>String Content</County>
      <FaxNumber>String Content</FaxNumber>
      <PhoneNumber1>String Content</PhoneNumber1>
      <PhoneNumber2>String Content</PhoneNumber2>
    </ResidentialAddress>
    <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
    <OtherID>String Content</OtherID>
    <FullName>String Content</FullName>
    <Gender>0</Gender>
    <SSN>String Content</SSN>
    <PrimaryPhoneNumber>String Content</PrimaryPhoneNumber>
    <Age>String Content</Age>
    <Legacy>0</Legacy>
    <AppointmentID>0</AppointmentID>
    <PatientStatusID>0</PatientStatusID>
  </PatientInfo>
  <AddToChart>false</AddToChart>
  <DocumentID>0</DocumentID>
  <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>
</MessageSendRequest>

Request Json Example (schema): 

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

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<MessageSendResponse>
  <MessageID>0</MessageID>
</MessageSendResponse>

Response Format: Json

Response Example (schema):

{
  "MessageID": 0
}