IPrimeSuiteAPI REST API Documentation


TaskListTypeGet


Method: POST

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

Request Format: Xml or Json

Request XML Example (schema): 

<?xml version="1.0" encoding="utf-16"?>
<TaskListTypeGetRequest>
  <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>
  <GetTaskListTypeDetails>true</GetTaskListTypeDetails>
</TaskListTypeGetRequest>

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,
  "GetTaskListTypeDetails": true
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<TaskListTypeGetResponse>
  <TaskListTypes>
    <TaskListTypeID>0</TaskListTypeID>
    <TaskListTypeName>String Content</TaskListTypeName>
    <TaskListTypeIcon>String Content</TaskListTypeIcon>
    <TaskListTypeDetails>
      <TaskListTypeDescription>String Content</TaskListTypeDescription>
      <TaskListPriorityID>0</TaskListPriorityID>
      <TaskListPriorityName>String Content</TaskListPriorityName>
      <TaskListStatus>
        <TaskListStatusName>String Content</TaskListStatusName>
        <TaskListStatusID>0</TaskListStatusID>
        <TaskListStatusDisplayOrder>0</TaskListStatusDisplayOrder>
      </TaskListStatus>
      <AddToFaceSheet>0</AddToFaceSheet>
      <DefaultFollowUp>0</DefaultFollowUp>
      <Careproviders>
        <CareProviderID>0</CareProviderID>
        <CareProviderFirstName>String Content</CareProviderFirstName>
        <CareProviderLastName>String Content</CareProviderLastName>
        <DefaultRecipients>
          <RecUserName>String Content</RecUserName>
          <RecUserLastName>String Content</RecUserLastName>
          <RecUserFirstName>String Content</RecUserFirstName>
          <RecipientID>0</RecipientID>
          <RecGroupName>String Content</RecGroupName>
          <RecType>0</RecType>
        </DefaultRecipients>
      </Careproviders>
    </TaskListTypeDetails>
  </TaskListTypes>
</TaskListTypeGetResponse>

Response Format: Json

Response Example (schema):

{
  "TaskListTypes": [
    {
      "TaskListTypeID": 0,
      "TaskListTypeName": "String Content",
      "TaskListTypeIcon": "String Content",
      "TaskListTypeDetails": {
        "TaskListTypeDescription": "String Content",
        "TaskListPriorityID": 0,
        "TaskListPriorityName": "String Content",
        "TaskListStatus": [
          {
            "TaskListStatusName": "String Content",
            "TaskListStatusID": 0,
            "TaskListStatusDisplayOrder": 0
          }
        ],
        "AddToFaceSheet": 0,
        "DefaultFollowUp": 0,
        "Careproviders": [
          {
            "CareProviderID": 0,
            "CareProviderFirstName": "String Content",
            "CareProviderLastName": "String Content",
            "DefaultRecipients": [
              {
                "RecUserName": "String Content",
                "RecUserLastName": "String Content",
                "RecUserFirstName": "String Content",
                "RecipientID": 0,
                "RecGroupName": "String Content",
                "RecType": 0
              }
            ]
          }
        ]
      }
    }
  ]
}