PUT api/buildings/{buildingId}

Updating a Building

Request Information

URI Parameters

NameDescriptionTypeAdditional information
buildingId

integer

Required

Body Parameters

BuildingUpdateViewModel
NameDescriptionTypeAdditional information
Name

Name

string

Required

Max length: 50

BuildingTypeId

Building Type

integer

Required

Block

Block

string

None.

Lot

Lot

string

None.

EffectiveDate

Effective Date

date

Required

TerminationDate

Termination Date

date

None.

AreaUnitOfMeasureId

Area Unit of Measure

integer

Required

CorporateBillingId

Corporate Billing

integer

Required

RequireCollectionsApproval

RequireCollectionsApproval

boolean

None.

Active

Active

boolean

None.

WriteOffBalance

Write off balance

decimal number

Range: inclusive between 0 and 99999999.99

Address

Address

SaveAddressViewModel

Required

ResidentBillingId

Resident billing

integer

Required

BaseChargeCodeId

Base Charge Code

integer

Required

StatementNoteId

Statement Note

integer

None.

MonthlyChargeDate

Last monthy charge date

date

Required

StatementApprovalId

Statement Approval

integer

Required

BankCodeID

BankCodeId

integer

Required

SaBankCodeID

SaBankCodeId

integer

None.

CheckFee

CheckFee

decimal number

Range: inclusive between 0 and 99999999.99

ChargeBackFeeAmount

ChargeBackFeeAmount

decimal number

Range: inclusive between 0 and 99999999.99

StatementDay

Statement Day

integer

None.

VacancyLoss

Vacancy Loss

boolean

None.

SupportSubtenant

Support Subtenant

boolean

None.

AreRecurringChargesRounded

Round Charges

boolean

None.

SupportConsolidatedBilling

Support consolidated billing

boolean

None.

ParkingSpaceAttached

Parking Space Attached

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "buildingTypeId": 1,
  "block": "sample string 2",
  "lot": "sample string 3",
  "effectiveDate": "2024-10-14T08:23:04.5335423-04:00",
  "terminationDate": "2024-10-14T08:23:04.5335423-04:00",
  "areaUnitOfMeasureId": 4,
  "corporateBillingId": 5,
  "requireCollectionsApproval": true,
  "active": true,
  "writeOffBalance": 8.0,
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zipCode": "sample string 5",
    "country": "sample string 6"
  },
  "residentBillingId": 9,
  "baseChargeCodeId": 10,
  "statementNoteId": 1,
  "monthlyChargeDate": "2024-10-14T08:23:04.5335423-04:00",
  "statementApprovalId": 11,
  "bankCodeID": 12,
  "saBankCodeID": 1,
  "checkFee": 1.0,
  "chargeBackFeeAmount": 1.0,
  "statementDay": 1,
  "vacancyLoss": true,
  "supportSubtenant": true,
  "areRecurringChargesRounded": true,
  "supportConsolidatedBilling": true,
  "parkingSpaceAttached": true
}

application/xml, text/xml

Sample:
<BuildingUpdateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Active>true</Active>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
  </Address>
  <AreRecurringChargesRounded>true</AreRecurringChargesRounded>
  <AreaUnitOfMeasureId>4</AreaUnitOfMeasureId>
  <BankCodeID>12</BankCodeID>
  <BaseChargeCodeId>10</BaseChargeCodeId>
  <Block>sample string 2</Block>
  <BuildingTypeId>1</BuildingTypeId>
  <ChargeBackFeeAmount>1</ChargeBackFeeAmount>
  <CheckFee>1</CheckFee>
  <CorporateBillingId>5</CorporateBillingId>
  <EffectiveDate>2024-10-14T08:23:04.5335423-04:00</EffectiveDate>
  <Lot>sample string 3</Lot>
  <MonthlyChargeDate>2024-10-14T08:23:04.5335423-04:00</MonthlyChargeDate>
  <Name>sample string 1</Name>
  <ParkingSpaceAttached>true</ParkingSpaceAttached>
  <RequireCollectionsApproval>true</RequireCollectionsApproval>
  <ResidentBillingId>9</ResidentBillingId>
  <SaBankCodeID>1</SaBankCodeID>
  <StatementApprovalId>11</StatementApprovalId>
  <StatementDay>1</StatementDay>
  <StatementNoteId>1</StatementNoteId>
  <SupportConsolidatedBilling>true</SupportConsolidatedBilling>
  <SupportSubtenant>true</SupportSubtenant>
  <TerminationDate>2024-10-14T08:23:04.5335423-04:00</TerminationDate>
  <VacancyLoss>true</VacancyLoss>
  <WriteOffBalance>8</WriteOffBalance>
</BuildingUpdateViewModel>

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 'BuildingUpdateViewModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.