POST api/collectionsbuildingpolicies

Insert a new CollectionsBuildingPolicy

Request Information

URI Parameters

None.

Body Parameters

CollectionsBuildingPolicyViewModel>ViewModel

CollectionsBuildingPolicyCreateFromGlobalViewModel

Name	Description	Type	Additional information
GlobalPolicyId	Parent's PolicyId	integer	Required Range: inclusive between 0 and 2147483647
BuildingId	BuildingId	integer	Required Range: inclusive between 0 and 2147483647
StartDate	StartDate	date	Required
EndDate	EndDate	date	Required
StageActionAttributeLinks	Profiles	Collection of CollectionsBuildingStageActionAttributeLinkCreateFromPolicyViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "globalPolicyId": 1,
  "buildingId": 1,
  "startDate": "2024-10-14T04:26:11.0668962-04:00",
  "endDate": "2024-10-14T04:26:11.0668962-04:00",
  "stageActionAttributeLinks": [
    {
      "globalStageActionAttributeLinkId": 1,
      "value": "sample string 2"
    },
    {
      "globalStageActionAttributeLinkId": 1,
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<CollectionsBuildingPolicyCreateFromGlobalViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuildingId>1</BuildingId>
  <EndDate>2024-10-14T04:26:11.0668962-04:00</EndDate>
  <GlobalPolicyId>1</GlobalPolicyId>
  <StageActionAttributeLinks>
    <CollectionsBuildingStageActionAttributeLinkCreateFromPolicyViewModel>
      <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
      <Value>sample string 2</Value>
    </CollectionsBuildingStageActionAttributeLinkCreateFromPolicyViewModel>
    <CollectionsBuildingStageActionAttributeLinkCreateFromPolicyViewModel>
      <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
      <Value>sample string 2</Value>
    </CollectionsBuildingStageActionAttributeLinkCreateFromPolicyViewModel>
  </StageActionAttributeLinks>
  <StartDate>2024-10-14T04:26:11.0668962-04:00</StartDate>
</CollectionsBuildingPolicyCreateFromGlobalViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CollectionsBuildingPolicyCreateFromGlobalViewModel'.

Response Information

Resource Description

CollectionsBuildingPolicyViewModel>ViewModel

CollectionsBuildingPolicyViewModel

Name	Description	Type	Additional 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-14T04:26:11.0825571-04:00",
  "endDate": "2024-10-14T04:26:11.0825571-04:00",
  "isDeleted": true,
  "createdBy": 8,
  "createdOn": "2024-10-14T04:26:11.0825571-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T04:26:11.0825571-04:00"
}

application/xml, text/xml

Sample:

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