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	-
CategoryGuid	Guid of category	globally unique identifier	-
CategoryName	Name of category.	string	-
Name	Name.	string	-
Description	Description.	string	-
Code	Code.	string	-
AvailableRelationTypes	RelationTypes that the buildingblock is available for.	Collection of CustomBuildingBlockRelationType	-
Type	Type.	CustomBuildingBlockType	-
ValuePossibilities	ValuePossibilities.	Collection of CustomBuildingBlockValuePossibility	-
CustomBuildingBlockText	CustomBuildingBlockText.	CustomBuildingBlockText	-
CustomBuildingBlockNumber	CustomBuildingBlockNumber.	CustomBuildingBlockNumber	-
CustomBuildingBlockDateTime	CustomBuildingBlockDate.	CustomBuildingBlockDateTime	-
HasReadPermission	HasReadPermission.	boolean	-
HasInsertPermission	HasInsertPermission.	boolean	-
HasEditPermission	HasEditPermission.	boolean	-
HasDeletePermission	HasDeletePermission.	boolean	-

Response Formats

application/json, text/json

Sample:

{
  "Guid": "057de28e-2352-4bbc-a7ae-48e8f635f099",
  "CategoryGuid": "fd567450-b1b5-4c40-a626-6f17afc7bcfd",
  "CategoryName": "sample string 3",
  "Name": "sample string 4",
  "Description": "sample string 5",
  "Code": "sample string 6",
  "AvailableRelationTypes": [
    {
      "$id": "2",
      "RelationTypeId": 1,
      "RelationTypeName": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "Type": 1,
  "ValuePossibilities": [
    {
      "$id": "3",
      "Guid": "1758d654-4563-42c0-90cd-e545701572fe",
      "Rank": 2,
      "Name": "sample string 3",
      "Code": "sample string 4",
      "Value": 1.0,
      "IsActive": true
    },
    {
      "$ref": "3"
    }
  ],
  "CustomBuildingBlockText": {
    "$id": "4",
    "DefaultValue": "sample string 1",
    "MaximumLength": 1,
    "EnableSpellCheck": true
  },
  "CustomBuildingBlockNumber": {
    "$id": "5",
    "DefaultValue": 1.0,
    "Decimals": 1,
    "MinimumValue": 1.0,
    "MaximumValue": 1.0
  },
  "CustomBuildingBlockDateTime": {
    "$id": "6",
    "DefaultValueOption": 1,
    "CustomDefaultValue": "2026-05-26T21:07:30.8054475+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">
  <AvailableRelationTypes>
    <CustomBuildingBlockRelationType>
      <RelationTypeId>1</RelationTypeId>
      <RelationTypeName>sample string 2</RelationTypeName>
    </CustomBuildingBlockRelationType>
    <CustomBuildingBlockRelationType>
      <RelationTypeId>1</RelationTypeId>
      <RelationTypeName>sample string 2</RelationTypeName>
    </CustomBuildingBlockRelationType>
  </AvailableRelationTypes>
  <CategoryGuid>fd567450-b1b5-4c40-a626-6f17afc7bcfd</CategoryGuid>
  <CategoryName>sample string 3</CategoryName>
  <Code>sample string 6</Code>
  <CustomBuildingBlockDateTime>
    <AllowedValueOption>AllDates</AllowedValueOption>
    <CustomDefaultValue>2026-05-26T21:07:30.8054475+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>057de28e-2352-4bbc-a7ae-48e8f635f099</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>1758d654-4563-42c0-90cd-e545701572fe</Guid>
      <IsActive>true</IsActive>
      <Name>sample string 3</Name>
      <Rank>2</Rank>
      <Value>1</Value>
    </CustomBuildingBlockValuePossibility>
    <CustomBuildingBlockValuePossibility>
      <Code>sample string 4</Code>
      <Guid>1758d654-4563-42c0-90cd-e545701572fe</Guid>
      <IsActive>true</IsActive>
      <Name>sample string 3</Name>
      <Rank>2</Rank>
      <Value>1</Value>
    </CustomBuildingBlockValuePossibility>
  </ValuePossibilities>
</CustomBuildingBlock>