GET CarePlans/ItemCategory

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	MatchCriteriaStringType	None.
CarePlanItemCategoryIDs	Collection of integer	None.
CategoryName	string	None.
CategoryDescription	string	None.
SortOrder	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CarePlanItemCategoryDTO

Name	Type	Additional information
CarePlanItemCategoryID	integer	None.
CategoryName	string	None.
CategoryDescription	string	None.
SortOrder	integer	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "carePlanItemCategoryID": 1,
    "categoryName": "sample string 2",
    "categoryDescription": "sample string 3",
    "sortOrder": 4,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:01:41.724525+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:01:41 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:01:41.724525+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:01:41 AM"
    },
    "summary": "sample string 3"
  },
  {
    "carePlanItemCategoryID": 1,
    "categoryName": "sample string 2",
    "categoryDescription": "sample string 3",
    "sortOrder": 4,
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:01:41.724525+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:01:41 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:01:41.724525+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:01:41 AM"
    },
    "summary": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCarePlanItemCategoryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CarePlanItemCategoryDTO>
    <CarePlanItemCategoryID>1</CarePlanItemCategoryID>
    <CategoryDescription>sample string 3</CategoryDescription>
    <CategoryName>sample string 2</CategoryName>
    <Created>
      <DateUtc>2024-12-04T08:01:41.724525+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <LastUpdated>
      <DateUtc>2024-12-04T08:01:41.724525+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <SortOrder>4</SortOrder>
  </CarePlanItemCategoryDTO>
  <CarePlanItemCategoryDTO>
    <CarePlanItemCategoryID>1</CarePlanItemCategoryID>
    <CategoryDescription>sample string 3</CategoryDescription>
    <CategoryName>sample string 2</CategoryName>
    <Created>
      <DateUtc>2024-12-04T08:01:41.724525+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <LastUpdated>
      <DateUtc>2024-12-04T08:01:41.724525+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <RecordState>Active</RecordState>
    <SortOrder>4</SortOrder>
  </CarePlanItemCategoryDTO>
</ArrayOfCarePlanItemCategoryDTO>

application/x-compressed-json

Sample:

��Q;
1�J��U�Q҉6~@��"l�ea�Y&��d�+Q�{�7��<x��e{��.+SO#���Xx:L'�E���97AC0����He]0	/�CNeK_��zI<�Y$�*�ܓ]�d~�!LЂ>�M`�"�Tm!�\��Ps������~�s�yJ������9C�w���	�U����f��2�L���~I�O�^"����n�;π�t