IPrimeSuiteAPI REST API Documentation


PrimeSuiteTaskCreate


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<PrimeSuiteTaskCreateRequest>
  <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>
  <TaskListTypeID>0</TaskListTypeID>
  <CareProviderID>0</CareProviderID>
  <LocationID>0</LocationID>
  <SendToRecipients>
    <RecipientID>0</RecipientID>
    <RecipientName>String Content</RecipientName>
    <RecipientType>0</RecipientType>
  </SendToRecipients>
  <CreateIndividualUserTasks>false</CreateIndividualUserTasks>
  <TaskListAssignedToID>0</TaskListAssignedToID>
  <PatientID>0</PatientID>
  <Subject>String Content</Subject>
  <TaskListPriority>0</TaskListPriority>
  <TaskListStatusID>0</TaskListStatusID>
  <TaskListDueDate>String Content</TaskListDueDate>
  <AddToFacesheet>false</AddToFacesheet>
  <TaskListFollowUp>false</TaskListFollowUp>
  <Comment>String Content</Comment>
  <TaskListDocuments>
    <DocumentID>0</DocumentID>
  </TaskListDocuments>
  <TaskListDatasource>String Content</TaskListDatasource>
</PrimeSuiteTaskCreateRequest>

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"
    }
  },
  "TaskListTypeID": 0,
  "CareProviderID": 0,
  "LocationID": 0,
  "SendToRecipients": [
    {
      "RecipientID": 0,
      "RecipientName": "String Content",
      "RecipientType": 0
    }
  ],
  "CreateIndividualUserTasks": false,
  "TaskListAssignedToID": 0,
  "PatientID": 0,
  "Subject": "String Content",
  "TaskListPriority": 0,
  "TaskListStatusID": 0,
  "TaskListDueDate": "String Content",
  "AddToFacesheet": false,
  "TaskListFollowUp": false,
  "Comment": "String Content",
  "TaskListDocuments": [
    {
      "DocumentID": 0
    }
  ],
  "TaskListDatasource": "String Content"
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PrimeSuiteTaskCreateResponse>
  <PrimeSuiteTaskList>
    <TaskListID>0</TaskListID>
    <TaskListCreatorFullName>String Content</TaskListCreatorFullName>
    <TaskListLastModifiedFullName>String Content</TaskListLastModifiedFullName>
    <TaskListCreateDateTime>String Content</TaskListCreateDateTime>
    <TaskListDataSource>String Content</TaskListDataSource>
    <TaskListTypeName>String Content</TaskListTypeName>
    <PatientLastName>String Content</PatientLastName>
    <TaskListDocuments>
      <DocumentID>0</DocumentID>
    </TaskListDocuments>
    <PatientFirstName>String Content</PatientFirstName>
    <TaskListPriorityID>0</TaskListPriorityID>
    <CommentCreator>String Content</CommentCreator>
    <CommentCreateDateTime>String Content</CommentCreateDateTime>
    <Subject>String Content</Subject>
    <TaskListDueDate>String Content</TaskListDueDate>
    <TaskListStatusName>String Content</TaskListStatusName>
    <Comment>String Content</Comment>
    <TaskListStatusID>0</TaskListStatusID>
    <TaskListPriorityName>String Content</TaskListPriorityName>
    <PatientID>0</PatientID>
    <CareProviderFullName>String Content</CareProviderFullName>
    <AssignedToUserName>String Content</AssignedToUserName>
    <SendToRecipients>
      <RecipientID>0</RecipientID>
      <RecipientName>String Content</RecipientName>
      <RecipientType>0</RecipientType>
    </SendToRecipients>
    <LocationName>String Content</LocationName>
  </PrimeSuiteTaskList>
</PrimeSuiteTaskCreateResponse>

Response Format: Json

Response Example (schema):

{
  "PrimeSuiteTaskList": [
    {
      "TaskListID": 0,
      "TaskListCreatorFullName": "String Content",
      "TaskListLastModifiedFullName": "String Content",
      "TaskListCreateDateTime": "String Content",
      "TaskListDataSource": "String Content",
      "TaskListTypeName": "String Content",
      "PatientLastName": "String Content",
      "TaskListDocuments": [
        {
          "DocumentID": 0
        }
      ],
      "PatientFirstName": "String Content",
      "TaskListPriorityID": 0,
      "CommentCreator": "String Content",
      "CommentCreateDateTime": "String Content",
      "Subject": "String Content",
      "TaskListDueDate": "String Content",
      "TaskListStatusName": "String Content",
      "Comment": "String Content",
      "TaskListStatusID": 0,
      "TaskListPriorityName": "String Content",
      "PatientID": 0,
      "CareProviderFullName": "String Content",
      "AssignedToUserName": "String Content",
      "SendToRecipients": [
        {
          "RecipientID": 0,
          "RecipientName": "String Content",
          "RecipientType": 0
        }
      ],
      "LocationName": "String Content"
    }
  ]
}