IPrimeSuiteAPI REST API Documentation


TaskListTaskDefaultGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

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

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"
    }
  },
  "TaskListUserSettingType": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskListTaskDefaultGetResponse>
  <TaskListTaskDefault>
    <TaskListTypeIcon>String Content</TaskListTypeIcon>
    <TaskListTypeID>0</TaskListTypeID>
    <PatientName>String Content</PatientName>
    <TaskListPriorityID>0</TaskListPriorityID>
    <DueDate>String Content</DueDate>
    <TaskListStatusName>String Content</TaskListStatusName>
    <TaskListStatusID>0</TaskListStatusID>
    <AddToFacesheet>false</AddToFacesheet>
    <FollowUpSelected>false</FollowUpSelected>
    <TaskListPriorityName>String Content</TaskListPriorityName>
    <PatientID>0</PatientID>
    <CareProviderFullName>String Content</CareProviderFullName>
    <CareProviderID>0</CareProviderID>
    <LocationID>0</LocationID>
    <AssignedToID>0</AssignedToID>
    <AssignedToName>String Content</AssignedToName>
    <AssignedToUserName>String Content</AssignedToUserName>
    <Recipients>
      <RecipientID>0</RecipientID>
      <RecipientName>String Content</RecipientName>
      <RecipientType>0</RecipientType>
    </Recipients>
    <LocationName>String Content</LocationName>
  </TaskListTaskDefault>
  <AutoRefresh>false</AutoRefresh>
</TaskListTaskDefaultGetResponse>

Response Format: Json

Response Example (schema):

{
  "TaskListTaskDefault": {
    "TaskListTypeIcon": "String Content",
    "TaskListTypeID": 0,
    "PatientName": "String Content",
    "TaskListPriorityID": 0,
    "DueDate": "String Content",
    "TaskListStatusName": "String Content",
    "TaskListStatusID": 0,
    "AddToFacesheet": false,
    "FollowUpSelected": false,
    "TaskListPriorityName": "String Content",
    "PatientID": 0,
    "CareProviderFullName": "String Content",
    "CareProviderID": 0,
    "LocationID": 0,
    "AssignedToID": 0,
    "AssignedToName": "String Content",
    "AssignedToUserName": "String Content",
    "Recipients": [
      {
        "RecipientID": 0,
        "RecipientName": "String Content",
        "RecipientType": 0
      }
    ],
    "LocationName": "String Content"
  },
  "AutoRefresh": false
}