IPrimeSuiteAPI REST API Documentation


UserTaskFilterListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

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

Request Json Example (schema): 

{
  "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"?>
<UserTaskFilterListGetResponse>
  <PatientListFilter>
    <FilterID>0</FilterID>
    <Description>String Content</Description>
    <Fields>
      <FieldID>0</FieldID>
      <Name>String Content</Name>
    </Fields>
    <CountOfTasks>0</CountOfTasks>
  </PatientListFilter>
</UserTaskFilterListGetResponse>

Response Format: Json

Response Example (schema):

{
  "PatientListFilter": [
    {
      "FilterID": 0,
      "Description": "String Content",
      "Fields": [
        {
          "FieldID": 0,
          "Name": "String Content"
        }
      ],
      "CountOfTasks": 0
    }
  ]
}