GET PlanCare2Api/CustomBuildingBlocks?relationTypeId={relationTypeId}

Gets list of CustomBuildingBlockSummary.

Request Information

URI Parameters

Name	Description	Type	Additional information
relationTypeId	Id of relationtype.	integer	Nullable

Body Parameters

None.

Response Information

Resource Description

List of CustomBuildingBlockSummary.

Collection of CustomBuildingBlockSummary

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	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Guid": "eea4126d-51be-4a48-b1de-b3cb54065249",
    "CategoryGuid": "f17429f1-5239-423a-b468-63800fb9ae5f",
    "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"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomBuildingBlockSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.BuildingBlock">
  <CustomBuildingBlockSummary>
    <AvailableRelationTypes>
      <CustomBuildingBlockRelationType>
        <RelationTypeId>1</RelationTypeId>
        <RelationTypeName>sample string 2</RelationTypeName>
      </CustomBuildingBlockRelationType>
      <CustomBuildingBlockRelationType>
        <RelationTypeId>1</RelationTypeId>
        <RelationTypeName>sample string 2</RelationTypeName>
      </CustomBuildingBlockRelationType>
    </AvailableRelationTypes>
    <CategoryGuid>f17429f1-5239-423a-b468-63800fb9ae5f</CategoryGuid>
    <CategoryName>sample string 3</CategoryName>
    <Code>sample string 6</Code>
    <Description>sample string 5</Description>
    <Guid>eea4126d-51be-4a48-b1de-b3cb54065249</Guid>
    <Name>sample string 4</Name>
  </CustomBuildingBlockSummary>
  <CustomBuildingBlockSummary>
    <AvailableRelationTypes>
      <CustomBuildingBlockRelationType>
        <RelationTypeId>1</RelationTypeId>
        <RelationTypeName>sample string 2</RelationTypeName>
      </CustomBuildingBlockRelationType>
      <CustomBuildingBlockRelationType>
        <RelationTypeId>1</RelationTypeId>
        <RelationTypeName>sample string 2</RelationTypeName>
      </CustomBuildingBlockRelationType>
    </AvailableRelationTypes>
    <CategoryGuid>f17429f1-5239-423a-b468-63800fb9ae5f</CategoryGuid>
    <CategoryName>sample string 3</CategoryName>
    <Code>sample string 6</Code>
    <Description>sample string 5</Description>
    <Guid>eea4126d-51be-4a48-b1de-b3cb54065249</Guid>
    <Name>sample string 4</Name>
  </CustomBuildingBlockSummary>
</ArrayOfCustomBuildingBlockSummary>