POST residentapi/archmods

Creates an archmod

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PropertyId	Connect Property Id	integer	Required
UnitId	Connect Unit Id	integer	Required
Description	Description	string	Required
StartDate	Date work is to commence. (Required for CREATE)	date	Required
EndDate	Date work is to be completed. (Required for CREATE)	date	Required
ResidentId	ResidentId	integer	Required
Notes	Notes	string	None.
CategoryIds	Categories Ids	Collection of integer	Required Min length: 1

Request Formats

application/json, text/json

Sample:

{
  "propertyId": 1,
  "unitId": 1,
  "description": "sample string 1",
  "startDate": "2025-12-24T09:11:15.1299647-05:00",
  "endDate": "2025-12-24T09:11:15.1299647-05:00",
  "residentId": 1,
  "notes": "sample string 2",
  "categoryIds": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArchMod

Name	Description	Type	Additional information
ArchModId	Arch Mod Id. Primary key of the arch mods table	integer	None.
PropertyId	Property Id. See the GET residentapi/properties/{propertyId} route to get the property data. (Required for CREATE)	integer	None.
UnitId	Unit Id. See the GET residentapi/units/{id} to get the unit data. (Required for CREATE)	integer	None.
ResidentId	ResidentId	integer	None.
OccupantName	Occupant Name	string	None.
UnitNumber	Unit Number	string	None.
Status	Status	string	None.
ProgressCode	ProgressCode	string	None.
Description	Description. (Required for CREATE)	string	None.
Notes	Notes	string	None.
DateSubmitted	DateSubmitted	date	None.
StartDate	Date work is to commence. (Required for CREATE)	date	None.
EndDate	Date work is to be completed. (Required for CREATE)	date	None.
Categories	Categories	Collection of ArchModCategory	None.
Attachments	Attachments	Collection of ArchModAttachment	None.

Response Formats

application/json, text/json

Sample:

{
  "archModId": 1,
  "propertyId": 2,
  "unitId": 1,
  "residentId": 1,
  "occupantName": "sample string 3",
  "unitNumber": "sample string 4",
  "status": "sample string 5",
  "progressCode": "sample string 6",
  "description": "sample string 7",
  "notes": "sample string 8",
  "dateSubmitted": "2025-12-24T09:11:15.1299647-05:00",
  "startDate": "2025-12-24T09:11:15.1299647-05:00",
  "endDate": "2025-12-24T09:11:15.1299647-05:00",
  "categories": [
    {
      "id": 1,
      "archModId": 2,
      "archModCategoryId": 3,
      "name": "sample string 4"
    },
    {
      "id": 1,
      "archModId": 2,
      "archModCategoryId": 3,
      "name": "sample string 4"
    }
  ],
  "attachments": [
    {
      "attachmentId": 1,
      "archModId": 2,
      "fileName": "sample string 3",
      "fileUrl": "sample string 4"
    },
    {
      "attachmentId": 1,
      "archModId": 2,
      "fileName": "sample string 3",
      "fileUrl": "sample string 4"
    }
  ]
}