PUT api/collectionsbuildingstages/{id}

Update a CollectionsBuildingStage

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

CollectionsBuildingStageUpdateViewModel
NameDescriptionTypeAdditional information
Name

Name

string

Required

Max length: 100

StageDay

StageDay

integer

Required

Range: inclusive between 1 and 2147483647

CalendarDay

CalendarDay

integer

Required

Range: inclusive between 1 and 2147483647

GraceDay

GraceDAy

integer

Required

Range: inclusive between 0 and 2147483647

ChargesDateThrough

ChargesDateThrough

integer

Required

Range: inclusive between 0 and 2147483647

IsManual

IsManual

boolean

Required

IsInLegal

IsInLegal

boolean

None.

IncludeDevelopers

IncludeDevelopers

boolean

None.

HoldStartDate

StartDate

date

None.

HoldEndDate

EndDate

date

None.

IsParcelIdReq

IsParcelIdReq

boolean

None.

LegalUnitNumber

LegalUnitNumber

boolean

None.

IsActive

IsActive

boolean

None.

CreditHistoryIds

CreditHistoryIds

Collection of integer

None.

SubAccountIds

SubAccountId

Collection of integer

None.

LastRunDate

date

None.

IsChargePostingOnRunDate

Gets or sets IsChargePostingOnRunDate

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "stageDay": 2,
  "calendarDay": 3,
  "graceDay": 1,
  "chargesDateThrough": 4,
  "isManual": true,
  "isInLegal": true,
  "includeDevelopers": true,
  "holdStartDate": "2024-10-14T04:22:15.7613701-04:00",
  "holdEndDate": "2024-10-14T04:22:15.7613701-04:00",
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "isActive": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ],
  "lastRunDate": "2024-10-14T04:22:15.7613701-04:00",
  "isChargePostingOnRunDate": true
}

application/xml, text/xml

Sample:
<CollectionsBuildingStageUpdateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CalendarDay>3</CalendarDay>
  <ChargesDateThrough>4</ChargesDateThrough>
  <CreditHistoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CreditHistoryIds>
  <GraceDay>1</GraceDay>
  <HoldEndDate>2024-10-14T04:22:15.7613701-04:00</HoldEndDate>
  <HoldStartDate>2024-10-14T04:22:15.7613701-04:00</HoldStartDate>
  <IncludeDevelopers>true</IncludeDevelopers>
  <IsActive>true</IsActive>
  <IsChargePostingOnRunDate>true</IsChargePostingOnRunDate>
  <IsInLegal>true</IsInLegal>
  <IsManual>true</IsManual>
  <IsParcelIdReq>true</IsParcelIdReq>
  <LastRunDate>2024-10-14T04:22:15.7613701-04:00</LastRunDate>
  <LegalUnitNumber>true</LegalUnitNumber>
  <Name>sample string 1</Name>
  <StageDay>2</StageDay>
  <SubAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubAccountIds>
</CollectionsBuildingStageUpdateViewModel>

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

Response Information

Resource Description

boolean

CollectionsBuildingStageViewModel
NameDescriptionTypeAdditional information
Id

BuildingStageID

integer

None.

BuildingPolicyProfileID

BuildingPolicyProfileID

integer

None.

GlobalStageID

Global StageID

integer

None.

Name

Name

string

None.

Number

Number

integer

None.

StageDay

StageDay

integer

None.

CalendarDay

CalendarDay

integer

None.

GraceDay

GraceDAy

integer

None.

ChargesDateThrough

ChargesDateThrough

integer

None.

IsManual

IsManual

boolean

None.

IsInLegal

IsInLegal

boolean

None.

IncludeDevelopers

IncludeDevelopers

boolean

None.

StartDate

StartDate

date

None.

EndDate

EndDate

date

None.

IsActive

IsActive

boolean

None.

IsDeleted

IsDeleted

boolean

None.

CreatedBy

CreatedBy

integer

None.

CreatedOn

CreatedOn

date

None.

ModifiedBy

ModifiedBy

integer

None.

ModifiedOn

ModifiedOn

date

None.

IsParcelIdReq

IsParcelIdReq

boolean

None.

LegalUnitNumber

LegalUnitNumber

boolean

None.

CreditHistoryIds

CreditHistoryIds

Collection of integer

None.

SubAccountIds

SubAccountId

Collection of integer

None.

LastRunDate

LastRunDate

date

None.

IsChargePostingOnRunDate

Gets or sets IsChargePostingOnRunDate

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "buildingPolicyProfileID": 2,
  "globalStageID": 1,
  "name": "sample string 3",
  "number": 4,
  "stageDay": 5,
  "calendarDay": 6,
  "graceDay": 7,
  "chargesDateThrough": 8,
  "isManual": true,
  "isInLegal": true,
  "includeDevelopers": true,
  "startDate": "2024-10-14T04:22:15.7613701-04:00",
  "endDate": "2024-10-14T04:22:15.7613701-04:00",
  "isActive": true,
  "isDeleted": true,
  "createdBy": 14,
  "createdOn": "2024-10-14T04:22:15.7613701-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T04:22:15.7613701-04:00",
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ],
  "lastRunDate": "2024-10-14T04:22:15.7613701-04:00",
  "isChargePostingOnRunDate": true
}

application/xml, text/xml

Sample:
<CollectionsBuildingStageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuildingPolicyProfileID>2</BuildingPolicyProfileID>
  <CalendarDay>6</CalendarDay>
  <ChargesDateThrough>8</ChargesDateThrough>
  <CreatedBy>14</CreatedBy>
  <CreatedOn>2024-10-14T04:22:15.7613701-04:00</CreatedOn>
  <CreditHistoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CreditHistoryIds>
  <EndDate>2024-10-14T04:22:15.7613701-04:00</EndDate>
  <GlobalStageID>1</GlobalStageID>
  <GraceDay>7</GraceDay>
  <Id>1</Id>
  <IncludeDevelopers>true</IncludeDevelopers>
  <IsActive>true</IsActive>
  <IsChargePostingOnRunDate>true</IsChargePostingOnRunDate>
  <IsDeleted>true</IsDeleted>
  <IsInLegal>true</IsInLegal>
  <IsManual>true</IsManual>
  <IsParcelIdReq>true</IsParcelIdReq>
  <LastRunDate>2024-10-14T04:22:15.7613701-04:00</LastRunDate>
  <LegalUnitNumber>true</LegalUnitNumber>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T04:22:15.7613701-04:00</ModifiedOn>
  <Name>sample string 3</Name>
  <Number>4</Number>
  <StageDay>5</StageDay>
  <StartDate>2024-10-14T04:22:15.7613701-04:00</StartDate>
  <SubAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubAccountIds>
</CollectionsBuildingStageViewModel>