IPrimeSuiteAPI REST API Documentation


TaskGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

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

Request Json Example (schema):

{
  "TaskID": 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"?>
<TaskGetResponse>
  <Task>
    <AddToFacesheet>false</AddToFacesheet>
    <AssignedToID>0</AssignedToID>
    <AssignedToUserName>String Content</AssignedToUserName>
    <Attachments>
      <Data>String Content</Data>
    </Attachments>
    <CareProviderID>0</CareProviderID>
    <CareProviderFullName>String Content</CareProviderFullName>
    <Comments>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <MessageBody>String Content</MessageBody>
      <CreatorUserName>String Content</CreatorUserName>
    </Comments>
    <CreatedDate>String Content</CreatedDate>
    <CreatorID>0</CreatorID>
    <CreatorName>String Content</CreatorName>
    <DataSource>String Content</DataSource>
    <DueDate>String Content</DueDate>
    <TaskListTypeID>0</TaskListTypeID>
    <TaskListTypeName>String Content</TaskListTypeName>
    <TaskListTypeIcon>String Content</TaskListTypeIcon>
    <FollowUpTaskSelected>false</FollowUpTaskSelected>
    <LastModifiedByID>0</LastModifiedByID>
    <LastModifiedByName>String Content</LastModifiedByName>
    <LastModifiedDate>String Content</LastModifiedDate>
    <LocationID>0</LocationID>
    <LocationName>String Content</LocationName>
    <PatientID>0</PatientID>
    <PatientName>String Content</PatientName>
    <Priority>String Content</Priority>
    <TaskID>0</TaskID>
    <PriorityID>0</PriorityID>
    <ReceivedDate>String Content</ReceivedDate>
    <Recipients>
      <RecipientID>0</RecipientID>
      <RecipientName>String Content</RecipientName>
      <RecipientType>0</RecipientType>
    </Recipients>
    <Status>String Content</Status>
    <StatusID>0</StatusID>
    <Subject>String Content</Subject>
    <TaskTypeTemplateReference>
      <Id>String Content</Id>
      <Version>String Content</Version>
    </TaskTypeTemplateReference>
    <TemplateFields>
      <FieldName>String Content</FieldName>
      <FieldType>0</FieldType>
      <FieldValue>String Content</FieldValue>
    </TemplateFields>
    <DocumentIDs>
      <DocumentID>0</DocumentID>
    </DocumentIDs>
  </Task>
</TaskGetResponse>

Response Format: Json

Response Example (schema):

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