PUT api/archmods/{id}

Update Arch Mods

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
id

(Required)

integer

Required

Body Parameters

ArchMod
NameDescriptionTypeAdditional information
ArchModId

Arch Mod Id. Primary key of the arch mods table.

integer

None.

PropertyId

Property Id. See the GET api/properties/{propertyId} route to get the property data.

integer

None.

UnitId

Unit Id. See the GET api/units/{unitId} route to get the unit data.

integer

None.

Description

Arch Mod description text

string

Required

ResidentId

Resident Id. See the GET api/residents/{Id} route to get the residents data.

integer

None.

ModuleProgressCodeId

Arch Mod Progress Code Id. See the GET api/moduleprogresscodes/{id} route to get the progress code data.

integer

None.

ReviewFee

Review Fee.

string

None.

NonRefundableDeposit

Non Refundable Deposit.

string

None.

RefundableDeposit

Refundable Deposit.

string

None.

DateReceived

Date Received.

date

None.

DateReviewFeeReceived

Date Review Fee Received.

date

None.

DateNonRefundableDepositReceived

Date Non Refundable Deposit Received.

date

None.

DateRefundableDepositReceived

Date Refundable Deposit Received.

date

None.

StartDate

Start Date.

date

None.

EndDate

End Date.

date

None.

ModuleStatusId

Module Status Id. See the GET api/modulestatus/{id} route to get the arch mod status.

integer

None.

Notes

Arch Mod notes text

string

None.

Categories

List of Category Ids. See the GET api/archmodcategories route to get a list of all arch mod categories.

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ArchModId": 1,
  "PropertyId": 2,
  "UnitId": 1,
  "Description": "sample string 3",
  "ResidentId": 1,
  "ModuleProgressCodeId": 1,
  "ReviewFee": "sample string 4",
  "NonRefundableDeposit": "sample string 5",
  "RefundableDeposit": "sample string 6",
  "DateReceived": "2025-12-24T05:23:06.6282352-05:00",
  "DateReviewFeeReceived": "2025-12-24T05:23:06.6282352-05:00",
  "DateNonRefundableDepositReceived": "2025-12-24T05:23:06.6282352-05:00",
  "DateRefundableDepositReceived": "2025-12-24T05:23:06.6282352-05:00",
  "StartDate": "2025-12-24T05:23:06.6282352-05:00",
  "EndDate": "2025-12-24T05:23:06.6282352-05:00",
  "ModuleStatusId": 7,
  "Notes": "sample string 8",
  "Categories": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

This method has no specific response - It returns an empty success response if it completes without error.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

Internal Error Codes

  • 106: ResourceNotFound
    (The requested resource was not found., NotFound)
  • 100: MissingRequiredHeader
    (Invalid request format. A required HTTP header was not specified., BadRequest)
  • 118: InvalidHeaderValue
    (The value provided for one of the HTTP headers was not in the correct format., BadRequest)
  • 199: UnknownError
    (Internal server error., InternalServerError)
  • 105: ResourceNotLinkedToUser
    (User is trying to access a resource that belongs to a property not linked to the user., Forbidden)
  • 112: InvalidOperation
    (The operation is not valid., Conflict)
  • 113: WriteOperationFailed
    (The requested operation failed., Conflict)
  • 109: MissingRequiredJsonParameter
    (Invalid request format. A required parameter in the request body was not specified for this request., BadRequest)
  • 114: InvalidJsonParameterValue
    (Invalid request format. The value provided for one of the parameters in the request body was not in the correct format., BadRequest)