GET api/buildings/{buildingId}/collectionsbuildingpolicies

GET: /api/buildings/{buildingid}/collectionsbuildingpolicies

Request Information

URI Parameters

NameDescriptionTypeAdditional information
buildingId

integer

Required

Body Parameters

None.

Response Information

Resource Description

This route returns all the collections policies related to a specific building.

Collection of CollectionsBuildingPolicyViewModel
NameDescriptionTypeAdditional information
Id

BuildingPolicyId

integer

None.

PolicyId

PolicyId

integer

None.

BuildingId

BuildingId

integer

None.

Name

Name

string

None.

Description

Description

string

None.

StartDate

StartDate

date

None.

EndDate

EndDate

date

None.

IsDeleted

IsDeleted

boolean

None.

CreatedBy

CreatedBy

integer

None.

CreatedOn

CreatedOn

date

None.

ModifiedBy

ModifiedBy

integer

None.

ModifiedOn

ModifiedOn

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "policyId": 1,
    "buildingId": 2,
    "name": "sample string 3",
    "description": "sample string 4",
    "startDate": "2024-10-13T08:25:15.7696168-04:00",
    "endDate": "2024-10-13T08:25:15.7696168-04:00",
    "isDeleted": true,
    "createdBy": 8,
    "createdOn": "2024-10-13T08:25:15.7696168-04:00",
    "modifiedBy": 1,
    "modifiedOn": "2024-10-13T08:25:15.7696168-04:00"
  },
  {
    "id": 1,
    "policyId": 1,
    "buildingId": 2,
    "name": "sample string 3",
    "description": "sample string 4",
    "startDate": "2024-10-13T08:25:15.7696168-04:00",
    "endDate": "2024-10-13T08:25:15.7696168-04:00",
    "isDeleted": true,
    "createdBy": 8,
    "createdOn": "2024-10-13T08:25:15.7696168-04:00",
    "modifiedBy": 1,
    "modifiedOn": "2024-10-13T08:25:15.7696168-04:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCollectionsBuildingPolicyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CollectionsBuildingPolicyViewModel>
    <BuildingId>2</BuildingId>
    <CreatedBy>8</CreatedBy>
    <CreatedOn>2024-10-13T08:25:15.7696168-04:00</CreatedOn>
    <Description>sample string 4</Description>
    <EndDate>2024-10-13T08:25:15.7696168-04:00</EndDate>
    <Id>1</Id>
    <IsDeleted>true</IsDeleted>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-13T08:25:15.7696168-04:00</ModifiedOn>
    <Name>sample string 3</Name>
    <PolicyId>1</PolicyId>
    <StartDate>2024-10-13T08:25:15.7696168-04:00</StartDate>
  </CollectionsBuildingPolicyViewModel>
  <CollectionsBuildingPolicyViewModel>
    <BuildingId>2</BuildingId>
    <CreatedBy>8</CreatedBy>
    <CreatedOn>2024-10-13T08:25:15.7696168-04:00</CreatedOn>
    <Description>sample string 4</Description>
    <EndDate>2024-10-13T08:25:15.7696168-04:00</EndDate>
    <Id>1</Id>
    <IsDeleted>true</IsDeleted>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-13T08:25:15.7696168-04:00</ModifiedOn>
    <Name>sample string 3</Name>
    <PolicyId>1</PolicyId>
    <StartDate>2024-10-13T08:25:15.7696168-04:00</StartDate>
  </CollectionsBuildingPolicyViewModel>
</ArrayOfCollectionsBuildingPolicyViewModel>