GET api/buildings/{buildingId}/collectionsbuildingpolicies/{policyId}/validate

POST: /api/buildings/{buildingid}/collectionsbuildingpolicies/{policyId}/validate

Request Information

URI Parameters

Name	Description	Type	Additional information
buildingId		integer	Required
policyId		integer	Required

Body Parameters

None.

Response Information

Resource Description

This route runs the custom validations on a building policy assignment and a list of CollectionsActionAttributeBuildingValidatorModel that has errors.

Collection of CollectionsActionAttributeBuildingValidatorViewModel

Name	Type	Additional information
ActionAttributeId	integer	None.
ActionStageLinkId	integer	None.
StageActionAttributeLinkId	integer	None.
Errors	Collection of string	None.
ActionAttribute	CollectionsActionAttributeReturnViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "actionAttributeId": 1,
    "actionStageLinkId": 2,
    "stageActionAttributeLinkId": 3,
    "errors": [
      "sample string 1",
      "sample string 2"
    ],
    "actionAttribute": {
      "actionAttributeId": 1,
      "actionAttributeName": "sample string 2",
      "parentActionAttributeId": 1,
      "actionAttributeValue": "sample string 3",
      "actionAttributeModifiedBy": 4,
      "actionAttributeModifiedOn": "2024-10-14T08:27:47.5483999-04:00",
      "dataTypeName": "sample string 6",
      "isNonTemplateSpecific": true,
      "collectionsActionAttributeValidators": [
        {
          "dataValidatorName": "sample string 1",
          "dataValidatorValue": "sample string 2",
          "isNonTemplateSpecific": true
        },
        {
          "dataValidatorName": "sample string 1",
          "dataValidatorValue": "sample string 2",
          "isNonTemplateSpecific": true
        }
      ],
      "collectionsAttributeDataTypeDescriptors": [
        {
          "collectionsAttributeDataSources": [
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            },
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            }
          ],
          "dataTypeDescriptorName": "sample string 1"
        },
        {
          "collectionsAttributeDataSources": [
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            },
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            }
          ],
          "dataTypeDescriptorName": "sample string 1"
        }
      ]
    }
  },
  {
    "actionAttributeId": 1,
    "actionStageLinkId": 2,
    "stageActionAttributeLinkId": 3,
    "errors": [
      "sample string 1",
      "sample string 2"
    ],
    "actionAttribute": {
      "actionAttributeId": 1,
      "actionAttributeName": "sample string 2",
      "parentActionAttributeId": 1,
      "actionAttributeValue": "sample string 3",
      "actionAttributeModifiedBy": 4,
      "actionAttributeModifiedOn": "2024-10-14T08:27:47.5483999-04:00",
      "dataTypeName": "sample string 6",
      "isNonTemplateSpecific": true,
      "collectionsActionAttributeValidators": [
        {
          "dataValidatorName": "sample string 1",
          "dataValidatorValue": "sample string 2",
          "isNonTemplateSpecific": true
        },
        {
          "dataValidatorName": "sample string 1",
          "dataValidatorValue": "sample string 2",
          "isNonTemplateSpecific": true
        }
      ],
      "collectionsAttributeDataTypeDescriptors": [
        {
          "collectionsAttributeDataSources": [
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            },
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            }
          ],
          "dataTypeDescriptorName": "sample string 1"
        },
        {
          "collectionsAttributeDataSources": [
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            },
            {
              "value": "sample string 1",
              "name": "sample string 2",
              "description": "sample string 3",
              "displayOrder": "sample string 4"
            }
          ],
          "dataTypeDescriptorName": "sample string 1"
        }
      ]
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfCollectionsActionAttributeBuildingValidatorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CollectionsActionAttributeBuildingValidatorViewModel>
    <ActionAttribute>
      <ActionAttributeId>1</ActionAttributeId>
      <ActionAttributeModifiedBy>4</ActionAttributeModifiedBy>
      <ActionAttributeModifiedOn>2024-10-14T08:27:47.5483999-04:00</ActionAttributeModifiedOn>
      <ActionAttributeName>sample string 2</ActionAttributeName>
      <ActionAttributeValue>sample string 3</ActionAttributeValue>
      <CollectionsActionAttributeValidators>
        <CollectionsActionAttributeValidatorReturnViewModel>
          <DataValidatorName>sample string 1</DataValidatorName>
          <DataValidatorValue>sample string 2</DataValidatorValue>
        </CollectionsActionAttributeValidatorReturnViewModel>
        <CollectionsActionAttributeValidatorReturnViewModel>
          <DataValidatorName>sample string 1</DataValidatorName>
          <DataValidatorValue>sample string 2</DataValidatorValue>
        </CollectionsActionAttributeValidatorReturnViewModel>
      </CollectionsActionAttributeValidators>
      <CollectionsAttributeDataTypeDescriptors>
        <CollectionsAttributeDataTypeDescriptorReturnViewModel>
          <CollectionsAttributeDataSources xmlns:d6p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
          </CollectionsAttributeDataSources>
          <DataTypeDescriptorName>sample string 1</DataTypeDescriptorName>
        </CollectionsAttributeDataTypeDescriptorReturnViewModel>
        <CollectionsAttributeDataTypeDescriptorReturnViewModel>
          <CollectionsAttributeDataSources xmlns:d6p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
          </CollectionsAttributeDataSources>
          <DataTypeDescriptorName>sample string 1</DataTypeDescriptorName>
        </CollectionsAttributeDataTypeDescriptorReturnViewModel>
      </CollectionsAttributeDataTypeDescriptors>
      <DataTypeName>sample string 6</DataTypeName>
      <IsNonTemplateSpecific>true</IsNonTemplateSpecific>
      <ParentActionAttributeId>1</ParentActionAttributeId>
    </ActionAttribute>
    <ActionAttributeId>1</ActionAttributeId>
    <ActionStageLinkId>2</ActionStageLinkId>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <StageActionAttributeLinkId>3</StageActionAttributeLinkId>
  </CollectionsActionAttributeBuildingValidatorViewModel>
  <CollectionsActionAttributeBuildingValidatorViewModel>
    <ActionAttribute>
      <ActionAttributeId>1</ActionAttributeId>
      <ActionAttributeModifiedBy>4</ActionAttributeModifiedBy>
      <ActionAttributeModifiedOn>2024-10-14T08:27:47.5483999-04:00</ActionAttributeModifiedOn>
      <ActionAttributeName>sample string 2</ActionAttributeName>
      <ActionAttributeValue>sample string 3</ActionAttributeValue>
      <CollectionsActionAttributeValidators>
        <CollectionsActionAttributeValidatorReturnViewModel>
          <DataValidatorName>sample string 1</DataValidatorName>
          <DataValidatorValue>sample string 2</DataValidatorValue>
        </CollectionsActionAttributeValidatorReturnViewModel>
        <CollectionsActionAttributeValidatorReturnViewModel>
          <DataValidatorName>sample string 1</DataValidatorName>
          <DataValidatorValue>sample string 2</DataValidatorValue>
        </CollectionsActionAttributeValidatorReturnViewModel>
      </CollectionsActionAttributeValidators>
      <CollectionsAttributeDataTypeDescriptors>
        <CollectionsAttributeDataTypeDescriptorReturnViewModel>
          <CollectionsAttributeDataSources xmlns:d6p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
          </CollectionsAttributeDataSources>
          <DataTypeDescriptorName>sample string 1</DataTypeDescriptorName>
        </CollectionsAttributeDataTypeDescriptorReturnViewModel>
        <CollectionsAttributeDataTypeDescriptorReturnViewModel>
          <CollectionsAttributeDataSources xmlns:d6p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Collections">
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
            <d6p1:CollectionsAttributeDataSourceViewModel>
              <d6p1:Description>sample string 3</d6p1:Description>
              <d6p1:DisplayOrder>sample string 4</d6p1:DisplayOrder>
              <d6p1:Name>sample string 2</d6p1:Name>
              <d6p1:Value>sample string 1</d6p1:Value>
            </d6p1:CollectionsAttributeDataSourceViewModel>
          </CollectionsAttributeDataSources>
          <DataTypeDescriptorName>sample string 1</DataTypeDescriptorName>
        </CollectionsAttributeDataTypeDescriptorReturnViewModel>
      </CollectionsAttributeDataTypeDescriptors>
      <DataTypeName>sample string 6</DataTypeName>
      <IsNonTemplateSpecific>true</IsNonTemplateSpecific>
      <ParentActionAttributeId>1</ParentActionAttributeId>
    </ActionAttribute>
    <ActionAttributeId>1</ActionAttributeId>
    <ActionStageLinkId>2</ActionStageLinkId>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <StageActionAttributeLinkId>3</StageActionAttributeLinkId>
  </CollectionsActionAttributeBuildingValidatorViewModel>
</ArrayOfCollectionsActionAttributeBuildingValidatorViewModel>