POST CarePlans/CarePlan?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

CarePlanDTO

Name	Type	Additional information
CarePlanID	integer	None.
CarePlanResponseCodeTableID	integer	None.
CarePlanResponseCodeTableName	string	None.
CarePlanName	string	None.
Type	CarePlanType	None.
Title	string	None.
Props	Collection of Object	None.
SortOrder	integer	None.
Comments	string	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
BusinessUnits	Collection of CarePlanBusinessUnitDTO	None.
CarePlanItems	Collection of CarePlanItemLinkDTO	None.
ResponseSubCodes	Collection of CarePlanResponseSubCodeDTO	None.
Summary	string	None.

Request Formats

application/json, text/json

Sample:

{
  "carePlanID": 1,
  "carePlanResponseCodeTableID": 2,
  "carePlanResponseCodeTableName": "sample string 3",
  "carePlanName": "sample string 4",
  "type": 1,
  "title": "sample string 5",
  "sortOrder": 6,
  "comments": "sample string 7",
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
  },
  "businessUnits": [
    {
      "buid": 1,
      "carePlanID": 2,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "businessUnitName": "sample string 3",
      "summary": "sample string 3"
    },
    {
      "buid": 1,
      "carePlanID": 2,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "businessUnitName": "sample string 3",
      "summary": "sample string 3"
    }
  ],
  "carePlanItems": [
    {
      "carePlanItemLinkID": 1,
      "carePlanID": 2,
      "carePlanName": "sample string 3",
      "carePlanTitle": "sample string 4",
      "carePlanItemID": 5,
      "parentCarePlanItemLinkID": 1,
      "isDefault": true,
      "isRequired": true,
      "sortOrder": 8,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "carePlanItemName": "sample string 9",
      "carePlanItemCaption": "sample string 10",
      "carePlanItemType": 1,
      "carePlanItemAnswerType": 1,
      "carePlanItemCategoryID": 11,
      "categoryName": "sample string 12",
      "categoryDescription": "sample string 13",
      "carePlanItemIsCustom": true,
      "summary": "sample string 9"
    },
    {
      "carePlanItemLinkID": 1,
      "carePlanID": 2,
      "carePlanName": "sample string 3",
      "carePlanTitle": "sample string 4",
      "carePlanItemID": 5,
      "parentCarePlanItemLinkID": 1,
      "isDefault": true,
      "isRequired": true,
      "sortOrder": 8,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "carePlanItemName": "sample string 9",
      "carePlanItemCaption": "sample string 10",
      "carePlanItemType": 1,
      "carePlanItemAnswerType": 1,
      "carePlanItemCategoryID": 11,
      "categoryName": "sample string 12",
      "categoryDescription": "sample string 13",
      "carePlanItemIsCustom": true,
      "summary": "sample string 9"
    }
  ],
  "responseSubCodes": [
    {
      "carePlanResponseSubCodeID": 1,
      "carePlanResponseCodeID": 2,
      "responseSubCodeName": "sample string 3",
      "responseSubCode": "sample string 4",
      "responseSubCodeDescription": "sample string 5",
      "sortOrder": 6,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "responseCodeName": "sample string 7",
      "responseCode": "sample string 8",
      "responseCodeDescription": "sample string 9",
      "summary": "sample string 7, sample string 3: sample string 5"
    },
    {
      "carePlanResponseSubCodeID": 1,
      "carePlanResponseCodeID": 2,
      "responseSubCodeName": "sample string 3",
      "responseSubCode": "sample string 4",
      "responseSubCodeDescription": "sample string 5",
      "sortOrder": 6,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:53:04.9009837+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:53:04 AM"
      },
      "responseCodeName": "sample string 7",
      "responseCode": "sample string 8",
      "responseCodeDescription": "sample string 9",
      "summary": "sample string 7, sample string 3: sample string 5"
    }
  ],
  "summary": "sample string 4"
}

application/xml, text/xml

Sample:

<CarePlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <BusinessUnits>
    <CarePlanBusinessUnitDTO>
      <BUID>1</BUID>
      <BusinessUnitName>sample string 3</BusinessUnitName>
      <CarePlanID>2</CarePlanID>
      <Created>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
    </CarePlanBusinessUnitDTO>
    <CarePlanBusinessUnitDTO>
      <BUID>1</BUID>
      <BusinessUnitName>sample string 3</BusinessUnitName>
      <CarePlanID>2</CarePlanID>
      <Created>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
    </CarePlanBusinessUnitDTO>
  </BusinessUnits>
  <CarePlanID>1</CarePlanID>
  <CarePlanItems>
    <CarePlanItemLinkDTO>
      <CarePlanID>2</CarePlanID>
      <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
      <CarePlanItemCaption>sample string 10</CarePlanItemCaption>
      <CarePlanItemCategoryID>11</CarePlanItemCategoryID>
      <CarePlanItemID>5</CarePlanItemID>
      <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <CarePlanItemName>sample string 9</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 3</CarePlanName>
      <CarePlanTitle>sample string 4</CarePlanTitle>
      <CategoryDescription>sample string 13</CategoryDescription>
      <CategoryName>sample string 12</CategoryName>
      <Created>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
      <RecordState>Active</RecordState>
      <SortOrder>8</SortOrder>
    </CarePlanItemLinkDTO>
    <CarePlanItemLinkDTO>
      <CarePlanID>2</CarePlanID>
      <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
      <CarePlanItemCaption>sample string 10</CarePlanItemCaption>
      <CarePlanItemCategoryID>11</CarePlanItemCategoryID>
      <CarePlanItemID>5</CarePlanItemID>
      <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <CarePlanItemName>sample string 9</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 3</CarePlanName>
      <CarePlanTitle>sample string 4</CarePlanTitle>
      <CategoryDescription>sample string 13</CategoryDescription>
      <CategoryName>sample string 12</CategoryName>
      <Created>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
      <RecordState>Active</RecordState>
      <SortOrder>8</SortOrder>
    </CarePlanItemLinkDTO>
  </CarePlanItems>
  <CarePlanName>sample string 4</CarePlanName>
  <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID>
  <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName>
  <Comments>sample string 7</Comments>
  <Created>
    <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <LastUpdated>
    <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <RecordState>Active</RecordState>
  <ResponseSubCodes>
    <CarePlanResponseSubCodeDTO>
      <CarePlanResponseCodeID>2</CarePlanResponseCodeID>
      <CarePlanResponseSubCodeID>1</CarePlanResponseSubCodeID>
      <Created>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <ResponseCode>sample string 8</ResponseCode>
      <ResponseCodeDescription>sample string 9</ResponseCodeDescription>
      <ResponseCodeName>sample string 7</ResponseCodeName>
      <ResponseSubCode>sample string 4</ResponseSubCode>
      <ResponseSubCodeDescription>sample string 5</ResponseSubCodeDescription>
      <ResponseSubCodeName>sample string 3</ResponseSubCodeName>
      <SortOrder>6</SortOrder>
    </CarePlanResponseSubCodeDTO>
    <CarePlanResponseSubCodeDTO>
      <CarePlanResponseCodeID>2</CarePlanResponseCodeID>
      <CarePlanResponseSubCodeID>1</CarePlanResponseSubCodeID>
      <Created>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:53:04.9009837+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <ResponseCode>sample string 8</ResponseCode>
      <ResponseCodeDescription>sample string 9</ResponseCodeDescription>
      <ResponseCodeName>sample string 7</ResponseCodeName>
      <ResponseSubCode>sample string 4</ResponseSubCode>
      <ResponseSubCodeDescription>sample string 5</ResponseSubCodeDescription>
      <ResponseSubCodeName>sample string 3</ResponseSubCodeName>
      <SortOrder>6</SortOrder>
    </CarePlanResponseSubCodeDTO>
  </ResponseSubCodes>
  <SortOrder>6</SortOrder>
  <Title>sample string 5</Title>
  <Type>Primary</Type>
</CarePlanDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��V;��0���6�,�qd�[�M��൫�-MD$J!)��'K�#�
!��-Q�,�dv����`�̐�~�<��
�TP�v����l7 �KH���P��3��D��e]�'�`�����( �u��|�b�B�"+�>�"o4cU���@c
�U"�WT�����9�\/v*��D7~p��-��2$8z�`�����cM�H�1&��,�8}^�=?��n���w�=.PA����K	��H�A�g&��O���^<��r�/9��)�P38���N��mot-��j�Kk<�unGg]��W�����U:�k�B�B!�Dư�o
F����+WH��+�(sb��Z��p>���?o^�x��w��Tg�ǳ�g_������	6VhכL���R8YKΓʵ�k	�ז؛Bj��������OǦ��q_��ށ��p�=da�r0�q��xn8���(s���`e�Jf�U)ĳu�NqW��:_Xu��G��7�;*�

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.