IPrimeSuiteAPI REST API Documentation

TaskUserListGet

Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/User/Task/TaskUserListGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskUserListGetRequest>
  <Name>String Content</Name>
  <TypeID>0</TypeID>
  <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>
</TaskUserListGetRequest>

Request Json Example (schema):

{
  "Name": "String Content",
  "TypeID": 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"?>
<TaskUserListGetResponse>
  <Groups>
    <GroupName>String Content</GroupName>
    <GroupID>0</GroupID>
    <Users>
      <DisplayName>String Content</DisplayName>
      <UserName>String Content</UserName>
      <RecipientID>0</RecipientID>
      <Type>String Content</Type>
      <TypeID>0</TypeID>
    </Users>
  </Groups>
  <Users>
    <DisplayName>String Content</DisplayName>
    <UserName>String Content</UserName>
    <RecipientID>0</RecipientID>
    <Type>String Content</Type>
    <TypeID>0</TypeID>
  </Users>
</TaskUserListGetResponse>

Response Format: Json

Response Example (schema):

{
  "Groups": [
    {
      "GroupName": "String Content",
      "GroupID": 0,
      "Users": [
        {
          "DisplayName": "String Content",
          "UserName": "String Content",
          "RecipientID": 0,
          "Type": "String Content",
          "TypeID": 0
        }
      ]
    }
  ],
  "Users": [
    {
      "DisplayName": "String Content",
      "UserName": "String Content",
      "RecipientID": 0,
      "Type": "String Content",
      "TypeID": 0
    }
  ]
}