GET PlanCare2Api/ClientplansV2/Types?sectorId={sectorId}

Retrieve the types of a clientplan V2 based on the sector.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

Name	Description	Type	Additional information
sectorId	Sector identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of clientplan V2 types based on the sector

Collection of ClientplanV2Type

Name	Description	Type	Additional information
Id	The identity of the Clientplan type.	integer	None
Name	The name of the Clientplan type.	string	None
Description	The description of the Clientplan type.	string	None
CareDemandsRequired	Determines if CareDemands must be used when creating goals.	boolean	None
Roles	Selected RelationCorrelationRoles of the Clientplan type.	Collection of RelationCorrelationRole	None
UseStatusApproved	Determines whether the status approved is used.	boolean	None

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "CareDemandsRequired": true,
    "Roles": [
      {
        "$id": "2",
        "Guid": "90ebe428-c39a-4f1f-a188-dd9407da539c",
        "Name": "sample string 2",
        "IsActive": true
      },
      {
        "$ref": "2"
      }
    ],
    "UseStatusApproved": true
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanV2Type xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanV2Type>
    <CareDemandsRequired>true</CareDemandsRequired>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
      <d3p1:RelationCorrelationRole>
        <d3p1:Guid>90ebe428-c39a-4f1f-a188-dd9407da539c</d3p1:Guid>
        <d3p1:IsActive>true</d3p1:IsActive>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:RelationCorrelationRole>
      <d3p1:RelationCorrelationRole>
        <d3p1:Guid>90ebe428-c39a-4f1f-a188-dd9407da539c</d3p1:Guid>
        <d3p1:IsActive>true</d3p1:IsActive>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:RelationCorrelationRole>
    </Roles>
    <UseStatusApproved>true</UseStatusApproved>
  </ClientplanV2Type>
  <ClientplanV2Type>
    <CareDemandsRequired>true</CareDemandsRequired>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Roles xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Relation">
      <d3p1:RelationCorrelationRole>
        <d3p1:Guid>90ebe428-c39a-4f1f-a188-dd9407da539c</d3p1:Guid>
        <d3p1:IsActive>true</d3p1:IsActive>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:RelationCorrelationRole>
      <d3p1:RelationCorrelationRole>
        <d3p1:Guid>90ebe428-c39a-4f1f-a188-dd9407da539c</d3p1:Guid>
        <d3p1:IsActive>true</d3p1:IsActive>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:RelationCorrelationRole>
    </Roles>
    <UseStatusApproved>true</UseStatusApproved>
  </ClientplanV2Type>
</ArrayOfClientplanV2Type>