GET PlanCare2Api/CustomBuildingBlocks/{customBuildingBlockGuid}

Gets CustomBuildingBlock by guid.

Request Information

URI Parameters

Name	Description	Type	Additional information
customBuildingBlockGuid	Guid of CustomBuildingBlock.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

CustomBuildingBlock.

CustomBuildingBlock

Name	Description	Type	Additional information
Guid	Guid.	globally unique identifier	None
CategoryGuid	Guid of category	globally unique identifier	None
CategoryName	Name of category.	string	None
Name	Name.	string	None
Description	Description.	string	None
Code	Code.	string	None
Type	Type.	CustomBuildingBlockType	None
ValuePossibilities	ValuePossibilities.	Collection of CustomBuildingBlockValuePossibility	None
CustomBuildingBlockText	CustomBuildingBlockText.	CustomBuildingBlockText	None
CustomBuildingBlockNumber	CustomBuildingBlockNumber.	CustomBuildingBlockNumber	None
CustomBuildingBlockDateTime	CustomBuildingBlockDate.	CustomBuildingBlockDateTime	None
HasReadPermission	HasReadPermission.	boolean	None
HasInsertPermission	HasInsertPermission.	boolean	None
HasEditPermission	HasEditPermission.	boolean	None
HasDeletePermission	HasDeletePermission.	boolean	None

Response Formats

application/json, text/json

Sample:

{
  "Guid": "4de01be7-dc59-4e96-aee9-627faf9caf6a",
  "CategoryGuid": "e750f0c8-3b54-4c40-ab79-170f15cc33d0",
  "CategoryName": "sample string 3",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Code": "sample string 6",
  "Type": 1,
  "ValuePossibilities": [
    {
      "$id": "2",
      "Guid": "37ee1ddb-5cd4-4e48-8bc4-e45d4d4b746c",
      "Rank": 2,
      "Name": "sample string 3",
      "Code": "sample string 4",
      "Value": 1.0,
      "IsActive": true
    },
    {
      "$ref": "2"
    }
  ],
  "CustomBuildingBlockText": {
    "$id": "3",
    "DefaultValue": "sample string 1",
    "MaximumLength": 1,
    "EnableSpellCheck": true
  },
  "CustomBuildingBlockNumber": {
    "$id": "4",
    "DefaultValue": 1.0,
    "Decimals": 1,
    "MinimumValue": 1.0,
    "MaximumValue": 1.0
  },
  "CustomBuildingBlockDateTime": {
    "$id": "5",
    "DefaultValueOption": 1,
    "CustomDefaultValue": "2026-05-26T22:01:22.7025515+02:00",
    "AllowedValueOption": 1,
    "IncludeTime": true
  },
  "HasReadPermission": true,
  "HasInsertPermission": true,
  "HasEditPermission": true,
  "HasDeletePermission": true
}

application/xml, text/xml

Sample:

<CustomBuildingBlock xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.BuildingBlock">
  <CategoryGuid>e750f0c8-3b54-4c40-ab79-170f15cc33d0</CategoryGuid>
  <CategoryName>sample string 3</CategoryName>
  <Code>sample string 6</Code>
  <CustomBuildingBlockDateTime>
    <AllowedValueOption>AllDates</AllowedValueOption>
    <CustomDefaultValue>2026-05-26T22:01:22.7025515+02:00</CustomDefaultValue>
    <DefaultValueOption>NotApplicable</DefaultValueOption>
    <IncludeTime>true</IncludeTime>
  </CustomBuildingBlockDateTime>
  <CustomBuildingBlockNumber>
    <Decimals>1</Decimals>
    <DefaultValue>1</DefaultValue>
    <MaximumValue>1</MaximumValue>
    <MinimumValue>1</MinimumValue>
  </CustomBuildingBlockNumber>
  <CustomBuildingBlockText>
    <DefaultValue>sample string 1</DefaultValue>
    <EnableSpellCheck>true</EnableSpellCheck>
    <MaximumLength>1</MaximumLength>
  </CustomBuildingBlockText>
  <Description>sample string 5</Description>
  <Guid>4de01be7-dc59-4e96-aee9-627faf9caf6a</Guid>
  <HasDeletePermission>true</HasDeletePermission>
  <HasEditPermission>true</HasEditPermission>
  <HasInsertPermission>true</HasInsertPermission>
  <HasReadPermission>true</HasReadPermission>
  <Name>sample string 4</Name>
  <Type>Text</Type>
  <ValuePossibilities>
    <CustomBuildingBlockValuePossibility>
      <Code>sample string 4</Code>
      <Guid>37ee1ddb-5cd4-4e48-8bc4-e45d4d4b746c</Guid>
      <IsActive>true</IsActive>
      <Name>sample string 3</Name>
      <Rank>2</Rank>
      <Value>1</Value>
    </CustomBuildingBlockValuePossibility>
    <CustomBuildingBlockValuePossibility>
      <Code>sample string 4</Code>
      <Guid>37ee1ddb-5cd4-4e48-8bc4-e45d4d4b746c</Guid>
      <IsActive>true</IsActive>
      <Name>sample string 3</Name>
      <Rank>2</Rank>
      <Value>1</Value>
    </CustomBuildingBlockValuePossibility>
  </ValuePossibilities>
</CustomBuildingBlock>