POST Clients/CarePlanEntryItem?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

ClientCarePlanEntryItemDTO

Name	Type	Additional information
ClientCarePlanEntryID	integer	None.
CarePlanItemID	integer	None.
OriginalClientCarePlanEntryID	integer	None.
Type	CarePlanType	None.
ResponseType	ClientCarePlanItemResponseType	None.
CarePlanResponseSubCodeID	integer	None.
RecordState	ClinicalRecordState	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
ClientCarePlanEntryItemNotes	Collection of ClientCarePlanEntryItemNoteDTO	None.
CarePlanItemName	string	None.
CarePlanItemCaption	string	None.
CarePlanItemType	CarePlanItemType	None.
CarePlanItemCategoryID	integer	None.
ResponseSubCodeName	string	None.
ResponseSubCode	string	None.
ResponseSubCodeDescription	string	None.
ClientCarePlanID	integer	None.
CarePlanItemLinkID	integer	None.
ParentCarePlanItemLinkID	integer	None.
IsDefault	boolean	None.
IsRequired	boolean	None.
IsPersonalized	boolean	None.
IsFromRecommendation	boolean	None.
Summary	string	None.
CarePlanItemIsCustom	boolean	None.
CarePlanItemAnswerType	CarePlanItemAnswerType	None.
SortOrders	Collection of ClientCarePlanEntryItemsSortOrderDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "clientCarePlanEntryID": 1,
  "carePlanItemID": 2,
  "originalClientCarePlanEntryID": 1,
  "type": 1,
  "responseType": 1,
  "carePlanResponseSubCodeID": 1,
  "recordState": 1,
  "createdByUserID": 3,
  "lastUpdatedByUserID": 4,
  "created": {
    "dateUtc": "2024-12-04T08:10:36.3479697+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:10:36 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:10:36.3479697+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:10:36 AM"
  },
  "clientCarePlanEntryItemNotes": [
    {
      "clientCarePlanEntryItemNoteID": 1,
      "clientCarePlanEntryID": 2,
      "carePlanItemID": 3,
      "contents": "sample string 4",
      "carePlanItemType": 1,
      "carePlanName": "sample string 5",
      "carePlanItemName": "sample string 6",
      "carePlanItemCaption": "sample string 7",
      "recordState": 1,
      "createdByUserID": 8,
      "lastUpdatedByUserID": 9,
      "created": {
        "dateUtc": "2024-12-04T08:10:36.3479697+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:10:36 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:10:36.3479697+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:10:36 AM"
      },
      "summary": "sample string 4"
    },
    {
      "clientCarePlanEntryItemNoteID": 1,
      "clientCarePlanEntryID": 2,
      "carePlanItemID": 3,
      "contents": "sample string 4",
      "carePlanItemType": 1,
      "carePlanName": "sample string 5",
      "carePlanItemName": "sample string 6",
      "carePlanItemCaption": "sample string 7",
      "recordState": 1,
      "createdByUserID": 8,
      "lastUpdatedByUserID": 9,
      "created": {
        "dateUtc": "2024-12-04T08:10:36.3479697+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:10:36 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:10:36.3479697+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:10:36 AM"
      },
      "summary": "sample string 4"
    }
  ],
  "carePlanItemName": "sample string 5",
  "carePlanItemCaption": "sample string 6",
  "carePlanItemType": 1,
  "carePlanItemCategoryID": 7,
  "responseSubCodeName": "sample string 8",
  "responseSubCode": "sample string 9",
  "responseSubCodeDescription": "sample string 10",
  "clientCarePlanID": 1,
  "carePlanItemLinkID": 11,
  "parentCarePlanItemLinkID": 1,
  "isDefault": true,
  "isRequired": true,
  "isPersonalized": true,
  "isFromRecommendation": true,
  "summary": "sample string 5, sample string 8: sample string 9",
  "carePlanItemIsCustom": true,
  "carePlanItemAnswerType": 1,
  "sortOrders": [
    {
      "carePlanItemLinkID": 1,
      "sortOrder": 2
    },
    {
      "carePlanItemLinkID": 1,
      "sortOrder": 2
    }
  ]
}

application/xml, text/xml

Sample:

<ClientCarePlanEntryItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
  <CarePlanItemCaption>sample string 6</CarePlanItemCaption>
  <CarePlanItemCategoryID>7</CarePlanItemCategoryID>
  <CarePlanItemID>2</CarePlanItemID>
  <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
  <CarePlanItemLinkID>11</CarePlanItemLinkID>
  <CarePlanItemName>sample string 5</CarePlanItemName>
  <CarePlanItemType>Problem</CarePlanItemType>
  <CarePlanResponseSubCodeID>1</CarePlanResponseSubCodeID>
  <ClientCarePlanEntryID>1</ClientCarePlanEntryID>
  <ClientCarePlanEntryItemNotes>
    <ClientCarePlanEntryItemNoteDTO>
      <CarePlanItemCaption>sample string 7</CarePlanItemCaption>
      <CarePlanItemID>3</CarePlanItemID>
      <CarePlanItemName>sample string 6</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 5</CarePlanName>
      <ClientCarePlanEntryID>2</ClientCarePlanEntryID>
      <ClientCarePlanEntryItemNoteID>1</ClientCarePlanEntryItemNoteID>
      <Contents>sample string 4</Contents>
      <Created>
        <DateUtc>2024-12-04T08:10:36.3479697+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>8</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:10:36.3479697+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>9</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
    </ClientCarePlanEntryItemNoteDTO>
    <ClientCarePlanEntryItemNoteDTO>
      <CarePlanItemCaption>sample string 7</CarePlanItemCaption>
      <CarePlanItemID>3</CarePlanItemID>
      <CarePlanItemName>sample string 6</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 5</CarePlanName>
      <ClientCarePlanEntryID>2</ClientCarePlanEntryID>
      <ClientCarePlanEntryItemNoteID>1</ClientCarePlanEntryItemNoteID>
      <Contents>sample string 4</Contents>
      <Created>
        <DateUtc>2024-12-04T08:10:36.3479697+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>8</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:10:36.3479697+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>9</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
    </ClientCarePlanEntryItemNoteDTO>
  </ClientCarePlanEntryItemNotes>
  <ClientCarePlanID>1</ClientCarePlanID>
  <Created>
    <DateUtc>2024-12-04T08:10:36.3479697+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>3</CreatedByUserID>
  <IsDefault>true</IsDefault>
  <IsFromRecommendation>true</IsFromRecommendation>
  <IsPersonalized>true</IsPersonalized>
  <IsRequired>true</IsRequired>
  <LastUpdated>
    <DateUtc>2024-12-04T08:10:36.3479697+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>4</LastUpdatedByUserID>
  <OriginalClientCarePlanEntryID>1</OriginalClientCarePlanEntryID>
  <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
  <RecordState>Active</RecordState>
  <ResponseSubCode>sample string 9</ResponseSubCode>
  <ResponseSubCodeDescription>sample string 10</ResponseSubCodeDescription>
  <ResponseSubCodeName>sample string 8</ResponseSubCodeName>
  <ResponseType>NotDone</ResponseType>
  <SortOrders>
    <ClientCarePlanEntryItemsSortOrderDTO>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <SortOrder>2</SortOrder>
    </ClientCarePlanEntryItemsSortOrderDTO>
    <ClientCarePlanEntryItemsSortOrderDTO>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <SortOrder>2</SortOrder>
    </ClientCarePlanEntryItemsSortOrderDTO>
  </SortOrders>
  <Type>Primary</Type>
</ClientCarePlanEntryItemDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��U�n�0�a�UIV��-�[ @�N|*r`��AT$U�B����I��R��Z"�R ߈���3������0Ux_R�N��]�C�[�� o�$�؆	Zf�If[�n�PWRh|쀮ܪ
<�_2Y`��0��x0Դl�vY�l�UÙ�PRm�U����34��Ɂ@%�E�\D�c4'qD&ӷ�t��.fo��D�P�w��AS^�h����
�s��n,�"�����"hk����kh�'�U�N�@>��o	��R'�?�B�Ʋ��e
}��
﹯Y^�t@�he�o'�l>���e��%�6x���b��bO'8TyL��Ў���7r��ٿA��3��spxg�r��s�����E�_�gn`���xe�#�q4����֥bT�
���5S��r�JK;���c��|e]�9
�]��ؘjWa0����{�:�����|����TZ*�I�����������:����킈�2

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.