IPrimeSuiteAPI REST API Documentation


TaskListGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskListGetRequest>
  <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>
  <FilterID>0</FilterID>
  <PatientID>0</PatientID>
  <OrderBy>0</OrderBy>
  <Sort>0</Sort>
  <PageSize>0</PageSize>
  <PageStart>0</PageStart>
</TaskListGetRequest>

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"
    }
  },
  "FilterID": 0,
  "PatientID": 0,
  "OrderBy": 0,
  "Sort": 0,
  "PageSize": 0,
  "PageStart": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskListGetResponse>
  <TaskLists>
    <TaskID>0</TaskID>
    <AssigneeName>String Content</AssigneeName>
    <AssignedTo>0</AssignedTo>
    <DueDate>0001-01-01T00:00:00</DueDate>
    <Subject>String Content</Subject>
    <PatientID>0</PatientID>
    <PatientName>String Content</PatientName>
    <TaskListStatus>String Content</TaskListStatus>
    <TaskListType>String Content</TaskListType>
    <CreatorID>0</CreatorID>
    <CreatorName>String Content</CreatorName>
    <CreateDate>0001-01-01T00:00:00</CreateDate>
    <LastModifiedDate>0001-01-01T00:00:00</LastModifiedDate>
    <LastModifierID>0</LastModifierID>
    <LastModifierName>String Content</LastModifierName>
    <CareProviderID>0</CareProviderID>
    <CareProviderName>String Content</CareProviderName>
    <ServiceLocationID>0</ServiceLocationID>
    <ServiceLocationName>String Content</ServiceLocationName>
    <ReceivedDate>0001-01-01T00:00:00</ReceivedDate>
    <NoteText>String Content</NoteText>
    <TaskListPriority>0</TaskListPriority>
    <TaskNote>
      <NoteID>0</NoteID>
      <NoteDate>String Content</NoteDate>
      <CreatorID>0</CreatorID>
      <CreatorName>String Content</CreatorName>
      <CreatorUserName>String Content</CreatorUserName>
      <NoteText>String Content</NoteText>
    </TaskNote>
    <PatientHomePhone>String Content</PatientHomePhone>
    <PatientWorkPhone>String Content</PatientWorkPhone>
    <PatientOtherID>String Content</PatientOtherID>
    <TaskListTypeIcon>String Content</TaskListTypeIcon>
    <IsTaskListTaskUnopened>false</IsTaskListTaskUnopened>
    <IsTaskListTaskOverDue>false</IsTaskListTaskOverDue>
    <TaskListPatientHasFlag>false</TaskListPatientHasFlag>
  </TaskLists>
  <TotalRows>0</TotalRows>
</TaskListGetResponse>

Response Format: Json

Response Example (schema):

Could not generate example for response. Failed with error: Specified cast is not valid.