IPrimeSuiteAPI REST API Documentation


TaskListDetailUpdate


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskListDetailUpdateRequest>
  <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>
  <TaskList>
    <AssignedTo>0</AssignedTo>
    <CareProviderID>0</CareProviderID>
    <DueDate>String Content</DueDate>
    <LastModifierID>0</LastModifierID>
    <NoteText>String Content</NoteText>
    <Recipients>
      <RecipientID>0</RecipientID>
      <RecipientName>String Content</RecipientName>
      <RecipientType>0</RecipientType>
    </Recipients>
    <ServiceLocationID>0</ServiceLocationID>
    <Subject>String Content</Subject>
    <DeleteTask>false</DeleteTask>
    <TaskListID>0</TaskListID>
    <TaskListType>0</TaskListType>
    <TaskListStatus>0</TaskListStatus>
    <TaskListPriority>0</TaskListPriority>
    <DocumentIDs>
      <DocumentID>0</DocumentID>
    </DocumentIDs>
    <AddToFacesheet>false</AddToFacesheet>
    <FollowUpTask>false</FollowUpTask>
  </TaskList>
</TaskListDetailUpdateRequest>

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"
    }
  },
  "TaskList": {
    "AssignedTo": 0,
    "CareProviderID": 0,
    "DueDate": "String Content",
    "LastModifierID": 0,
    "NoteText": "String Content",
    "Recipients": [
      {
        "RecipientID": 0,
        "RecipientName": "String Content",
        "RecipientType": 0
      }
    ],
    "ServiceLocationID": 0,
    "Subject": "String Content",
    "DeleteTask": false,
    "TaskListID": 0,
    "TaskListType": 0,
    "TaskListStatus": 0,
    "TaskListPriority": 0,
    "DocumentIDs": [
      {
        "DocumentID": 0
      }
    ],
    "AddToFacesheet": false,
    "FollowUpTask": false
  }
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskListDetailUpdateResponse>
  <TaskListID>0</TaskListID>
  <Updated>false</Updated>
</TaskListDetailUpdateResponse>

Response Format: Json

Response Example (schema):

{
  "TaskListID": 0,
  "Updated": false
}