IPrimeSuiteAPI REST API Documentation


MessageAddressBookGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<AddressBookGetRequest>
  <UserCreatedGroups>false</UserCreatedGroups>
  <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>
</AddressBookGetRequest>

Request Json Example (schema): 

{
  "UserCreatedGroups": false,
  "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"?>
<AddressBookGetResponse>
  <Recipients>
    <RecipientID>0</RecipientID>
    <DisplayText>String Content</DisplayText>
    <Type>String Content</Type>
    <Name>String Content</Name>
  </Recipients>
</AddressBookGetResponse>

Response Format: Json

Response Example (schema):

{
  "Recipients": [
    {
      "RecipientID": 0,
      "DisplayText": "String Content",
      "Type": "String Content",
      "Name": "String Content"
    }
  ]
}