PUT api/workorders/{id}

Update a work order

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
id	(Required)	integer	Required

Body Parameters

WorkOrder

Name	Description	Type	Additional information
WorkorderId	Work Order Id. Primary key of work orders 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. This value will be NULL if the Common Area Id is provided.	integer	None.
CommonAreaId	Common Area Id. See the GET api/properties/{propertyId}/commonareas route to get common areas. This value will be NULL if the Unit Id is provided.	integer	None.
WorkorderCategoryId	Work Order Category ID. See the GET api/workordercategories/{categoryId} route to get the work order category data.	integer	None.
ModuleProgressCodeId	Module Progress Code Id. See the GET api/moduleprogresscodes/{id} route to get the progress code.	integer	None.
WorkorderDescription	Work Order Description.	string	None.
WorkorderNumber	Work Order Number. Used to assign the work order with a number other than the primary key workorderId.	integer	None.
WorkorderCompletionDate	Work Order Completion Date.	date	None.
ModuleStatusId	Module Status Id. See the GET api/modulestatus/{id} route to get the arch mod status.	integer	None.
WorkorderChargetohouseaccount	Work Order Charge to House Account.	string	None.
WorkorderAmount	Work Order Amount.	decimal number	None.
PriorityValue	Work Order Priority Value. See the GET api/workorders/priorities route to get workorder priorities.	integer	None.
Assignment	Assignment.	Collection of integer	None.
WorkorderDtmcreated	Work Order Date and Time Created.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "WorkorderId": 1,
  "PropertyId": 1,
  "UnitId": 1,
  "CommonAreaId": 1,
  "WorkorderCategoryId": 1,
  "ModuleProgressCodeId": 1,
  "WorkorderDescription": "sample string 2",
  "WorkorderNumber": 1,
  "WorkorderCompletionDate": "2025-12-24T05:22:15.6693578-05:00",
  "ModuleStatusId": 3,
  "WorkorderChargetohouseaccount": "sample string 4",
  "WorkorderAmount": 1.1,
  "PriorityValue": 1,
  "Assignment": [
    1,
    2
  ],
  "WorkorderDtmcreated": "2025-12-24T05:22:15.6693578-05:00"
}

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)