GET PlanCare2Api/CustomBuildingBlocks/Values?customBuildingBlockGuid={customBuildingBlockGuid}&relationId={relationId}

Gets list of values of a CustomBuildingBlock for a relation.

Relation(s) can be of the following types: Client, Prospect, Family, Employee

Request Information

URI Parameters

Name	Description	Type	Additional information
customBuildingBlockGuid	Guid of CustomBuildingBlock.	globally unique identifier	Required
relationId	Id of relation.	integer	Required

Body Parameters

None.

Response Information

Resource Description

List of CustomBuildingBlockValueSummary.

Collection of CustomBuildingBlockValueSummary

Name	Description	Type	Additional information
Id	Id.	integer	-
RelationByLookUpName	RelationByLookUpName.	string	-
ChangedOn	ChangedOn.	date	-
Value	TextValue.	string	-
Source	Source.	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "RelationByLookUpName": "sample string 2",
    "ChangedOn": "2026-05-26T23:14:59.4977808+02:00",
    "Value": "sample string 4",
    "Source": "sample string 5"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomBuildingBlockValueSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.BuildingBlock">
  <CustomBuildingBlockValueSummary>
    <ChangedOn>2026-05-26T23:14:59.4977808+02:00</ChangedOn>
    <Id>1</Id>
    <RelationByLookUpName>sample string 2</RelationByLookUpName>
    <Source>sample string 5</Source>
    <Value>sample string 4</Value>
  </CustomBuildingBlockValueSummary>
  <CustomBuildingBlockValueSummary>
    <ChangedOn>2026-05-26T23:14:59.4977808+02:00</ChangedOn>
    <Id>1</Id>
    <RelationByLookUpName>sample string 2</RelationByLookUpName>
    <Source>sample string 5</Source>
    <Value>sample string 4</Value>
  </CustomBuildingBlockValueSummary>
</ArrayOfCustomBuildingBlockValueSummary>