POST CarePlans/CarePlan/import?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

CarePlanPackage

Name	Type	Additional information
CarePlans	Collection of CarePlan	None.
CarePlanItems	Collection of CarePlanItem	None.
CarePlanItemLinks	Collection of CarePlanItemLink	None.

Request Formats

application/json, text/json

Sample:

{
  "carePlans": [
    {
      "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,
      "businessUnits": [
        {
          "buid": 1,
          "carePlanID": 2,
          "businessUnitName": "sample string 3",
          "recordState": 1
        },
        {
          "buid": 1,
          "carePlanID": 2,
          "businessUnitName": "sample string 3",
          "recordState": 1
        }
      ]
    },
    {
      "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,
      "businessUnits": [
        {
          "buid": 1,
          "carePlanID": 2,
          "businessUnitName": "sample string 3",
          "recordState": 1
        },
        {
          "buid": 1,
          "carePlanID": 2,
          "businessUnitName": "sample string 3",
          "recordState": 1
        }
      ]
    }
  ],
  "carePlanItems": [
    {
      "carePlanItemID": 1,
      "categoryName": "sample string 2",
      "carePlanName": "sample string 3",
      "categoryDescription": "sample string 4",
      "carePlanItemName": "sample string 5",
      "type": 1,
      "answerType": 1,
      "caption": "sample string 6",
      "isCustom": true,
      "clientCarePlanID": 1,
      "props": [],
      "recordState": 1
    },
    {
      "carePlanItemID": 1,
      "categoryName": "sample string 2",
      "carePlanName": "sample string 3",
      "categoryDescription": "sample string 4",
      "carePlanItemName": "sample string 5",
      "type": 1,
      "answerType": 1,
      "caption": "sample string 6",
      "isCustom": true,
      "clientCarePlanID": 1,
      "props": [],
      "recordState": 1
    }
  ],
  "carePlanItemLinks": [
    {
      "carePlanItemLinkID": 1,
      "carePlanID": 2,
      "carePlanName": "sample string 3",
      "carePlanTitle": "sample string 4",
      "carePlanItemID": 5,
      "parentCarePlanItemLinkID": 1,
      "parentCarePlanItemLinkName": "sample string 6",
      "problem": "sample string 7",
      "goal": "sample string 8",
      "isDefault": true,
      "isRequired": true,
      "sortOrder": 11,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:06:23.0350308+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:06:23.0350308+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
      },
      "carePlanItemName": "sample string 12",
      "carePlanItemCaption": "sample string 13",
      "carePlanItemType": 1,
      "carePlanItemAnswerType": 1,
      "carePlanItemCategoryID": 14,
      "categoryName": "sample string 15",
      "categoryDescription": "sample string 16",
      "summary": "sample string 12"
    },
    {
      "carePlanItemLinkID": 1,
      "carePlanID": 2,
      "carePlanName": "sample string 3",
      "carePlanTitle": "sample string 4",
      "carePlanItemID": 5,
      "parentCarePlanItemLinkID": 1,
      "parentCarePlanItemLinkName": "sample string 6",
      "problem": "sample string 7",
      "goal": "sample string 8",
      "isDefault": true,
      "isRequired": true,
      "sortOrder": 11,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T08:06:23.0350308+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:06:23.0350308+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:06:23 AM"
      },
      "carePlanItemName": "sample string 12",
      "carePlanItemCaption": "sample string 13",
      "carePlanItemType": 1,
      "carePlanItemAnswerType": 1,
      "carePlanItemCategoryID": 14,
      "categoryName": "sample string 15",
      "categoryDescription": "sample string 16",
      "summary": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:

<CarePlanPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models.ImportExport">
  <CarePlanItemLinks>
    <CarePlanItemLink>
      <CarePlanID>2</CarePlanID>
      <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
      <CarePlanItemCaption>sample string 13</CarePlanItemCaption>
      <CarePlanItemCategoryID>14</CarePlanItemCategoryID>
      <CarePlanItemID>5</CarePlanItemID>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <CarePlanItemName>sample string 12</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 3</CarePlanName>
      <CarePlanTitle>sample string 4</CarePlanTitle>
      <CategoryDescription>sample string 16</CategoryDescription>
      <CategoryName>sample string 15</CategoryName>
      <Created xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:06:23.0350308+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </Created>
      <Goal>sample string 8</Goal>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:06:23.0350308+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </LastUpdated>
      <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
      <ParentCarePlanItemLinkName>sample string 6</ParentCarePlanItemLinkName>
      <Problem>sample string 7</Problem>
      <RecordState>Active</RecordState>
      <SortOrder>11</SortOrder>
    </CarePlanItemLink>
    <CarePlanItemLink>
      <CarePlanID>2</CarePlanID>
      <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
      <CarePlanItemCaption>sample string 13</CarePlanItemCaption>
      <CarePlanItemCategoryID>14</CarePlanItemCategoryID>
      <CarePlanItemID>5</CarePlanItemID>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <CarePlanItemName>sample string 12</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 3</CarePlanName>
      <CarePlanTitle>sample string 4</CarePlanTitle>
      <CategoryDescription>sample string 16</CategoryDescription>
      <CategoryName>sample string 15</CategoryName>
      <Created xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:06:23.0350308+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </Created>
      <Goal>sample string 8</Goal>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
        <d4p1:DateUtc>2024-12-04T08:06:23.0350308+00:00</d4p1:DateUtc>
        <d4p1:UserName>sample string 2</d4p1:UserName>
      </LastUpdated>
      <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
      <ParentCarePlanItemLinkName>sample string 6</ParentCarePlanItemLinkName>
      <Problem>sample string 7</Problem>
      <RecordState>Active</RecordState>
      <SortOrder>11</SortOrder>
    </CarePlanItemLink>
  </CarePlanItemLinks>
  <CarePlanItems>
    <CarePlanItem>
      <AnswerType>New</AnswerType>
      <Caption>sample string 6</Caption>
      <CarePlanItemID>1</CarePlanItemID>
      <CarePlanItemName>sample string 5</CarePlanItemName>
      <CarePlanName>sample string 3</CarePlanName>
      <CategoryDescription>sample string 4</CategoryDescription>
      <CategoryName>sample string 2</CategoryName>
      <ClientCarePlanID>1</ClientCarePlanID>
      <IsCustom>true</IsCustom>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" />
      <RecordState>Active</RecordState>
      <Type>Problem</Type>
    </CarePlanItem>
    <CarePlanItem>
      <AnswerType>New</AnswerType>
      <Caption>sample string 6</Caption>
      <CarePlanItemID>1</CarePlanItemID>
      <CarePlanItemName>sample string 5</CarePlanItemName>
      <CarePlanName>sample string 3</CarePlanName>
      <CategoryDescription>sample string 4</CategoryDescription>
      <CategoryName>sample string 2</CategoryName>
      <ClientCarePlanID>1</ClientCarePlanID>
      <IsCustom>true</IsCustom>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" />
      <RecordState>Active</RecordState>
      <Type>Problem</Type>
    </CarePlanItem>
  </CarePlanItems>
  <CarePlans>
    <CarePlan>
      <BusinessUnits>
        <CarePlanBusinessUnit>
          <BUID>1</BUID>
          <BusinessUnitName>sample string 3</BusinessUnitName>
          <CarePlanID>2</CarePlanID>
          <RecordState>Active</RecordState>
        </CarePlanBusinessUnit>
        <CarePlanBusinessUnit>
          <BUID>1</BUID>
          <BusinessUnitName>sample string 3</BusinessUnitName>
          <CarePlanID>2</CarePlanID>
          <RecordState>Active</RecordState>
        </CarePlanBusinessUnit>
      </BusinessUnits>
      <CarePlanID>1</CarePlanID>
      <CarePlanName>sample string 4</CarePlanName>
      <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID>
      <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName>
      <Comments>sample string 7</Comments>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
      <RecordState>Active</RecordState>
      <SortOrder>6</SortOrder>
      <Title>sample string 5</Title>
      <Type>Primary</Type>
    </CarePlan>
    <CarePlan>
      <BusinessUnits>
        <CarePlanBusinessUnit>
          <BUID>1</BUID>
          <BusinessUnitName>sample string 3</BusinessUnitName>
          <CarePlanID>2</CarePlanID>
          <RecordState>Active</RecordState>
        </CarePlanBusinessUnit>
        <CarePlanBusinessUnit>
          <BUID>1</BUID>
          <BusinessUnitName>sample string 3</BusinessUnitName>
          <CarePlanID>2</CarePlanID>
          <RecordState>Active</RecordState>
        </CarePlanBusinessUnit>
      </BusinessUnits>
      <CarePlanID>1</CarePlanID>
      <CarePlanName>sample string 4</CarePlanName>
      <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID>
      <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName>
      <Comments>sample string 7</Comments>
      <Props xmlns:d4p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
      <RecordState>Active</RecordState>
      <SortOrder>6</SortOrder>
      <Title>sample string 5</Title>
      <Type>Primary</Type>
    </CarePlan>
  </CarePlans>
</CarePlanPackage>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��T���0��m|9R�Pw��y�bW�Z�DDR!)��_�"��_��:�e�>���
u��h�;�ÿ��<���RqeI��tz� 9�<���ZY���|SA�����HN,�u�uF�m���A@����P�	W
!B�6�)��|��ZJP���j�Ц���H7�
�])Ẏ7�(�z}l�����9�~�t�p�ȫ�Ⱥ��@z���Ӝl����k�ws�`#j'�
��_<H��g�F�fy<<L<���7�iIrg@l%p���}���[�!�G]�x�A��-j���=�_��2�V_��5��b����
���Z}�u|od��[ͫAbvu�yS�������F(���#���!)�'�H�+W`����
�oh����N�8yK��&t��ҜR,�X0��6Rr��"�"ߦ�m��;��H�Rq�Vu�Z�s�	,��b~a�Y�{�9�|/��;�6+����?�Φ�H���o���]��^�]��?��{
J

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.