Update Work Order

curl -X PUT https://api.fortresstech.io/v1/workOrders/workOrderId \
     -H "Content-Type: application/json" \
     -d '{
  "maintenanceIssueId": "maintenanceIssueId",
  "maintenanceLocationId": "maintenanceLocationId",
  "maintenanceLocationType": "COMMON_AREA",
  "priority": "LOW",
  "updatedBy": "updatedBy"
}'

{
  "status": "OPEN",
  "priority": "LOW",
  "hasPetAlert": true,
  "completedAt": "2024-01-15T09:30:00Z",
  "requestorPhone": "requestorPhone",
  "requestorEmail": "requestorEmail",
  "requestedStartDateFrom": "requestedStartDateFrom",
  "requestedStartDateTo": "requestedStartDateTo",
  "requestedStartTimeFrom": "requestedStartTimeFrom",
  "requestedStartTimeTo": "requestedStartTimeTo",
  "dueDate": "dueDate",
  "description": "description",
  "serviceNotes": "serviceNotes",
  "vendorNotes": "vendorNotes",
  "entryNotes": "entryNotes",
  "entryPreference": "24_HOUR_NOTICE",
  "isDoorCodeActive": true,
  "isAlarmActive": true,
  "doorCode": "doorCode",
  "alarmCode": "alarmCode",
  "holdReason": "holdReason",
  "otherLocationDetail": "otherLocationDetail",
  "attachmentIds": "attachmentIds",
  "technicianNotes": "technicianNotes",
  "previouslyReported": true,
  "id": "id",
  "readableId": "readableId",
  "idempotencyId": "idempotencyId",
  "createdAt": "createdAt",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "assignedUserId": "assignedUserId",
  "householdId": "householdId",
  "customerId": "customerId",
  "unitId": "unitId",
  "maintenanceIssueId": "maintenanceIssueId",
  "maintenanceLocationId": "maintenanceLocationId",
  "propertyId": "propertyId",
  "organizationId": "organizationId",
  "totalCostOfMaterialsUsed": 1.1,
  "totalAmountOwedByResident": 1.1,
  "totalAmountOwedByProperty": 1.1,
  "hourlyServiceRate": 1.1,
  "totalLaborCost": 1.1
}

Update information for a specific work order

Path parameters

workOrderIdstringRequired

The id of the work order

Request

This endpoint expects an object.

maintenanceIssueIdstringRequiredformat: "uuid"

ID from the maintenance issue api response.

maintenanceLocationIdstringRequiredformat: "uuid"

ID from the maintenance location api response.

maintenanceLocationTypeenumRequired

Indicates the type of location. Used to conditionally require certain fields (e.g., unitId, householdId).

Allowed values:

priorityenumRequired

Allowed values:

updatedBystringRequiredformat: "uuid"

alarmCodestringOptional

The alarm code for the location.

customerIdstringOptionalformat: "uuid"

ID from the Customer table. Required if maintenanceLocationType is UNIT.

descriptionstringOptional<=500 characters

doorCodestringOptional

The door code for the location.

dueDatestringOptionalformat: "date"

The due date for the work order.

entryNotesstringOptional<=500 characters

entryPreferenceenumOptional

Allowed values:

hasPetAlertbooleanOptional

Indicates if there are pets at the location.

holdReasonstringOptional

hourlyServiceRatedoubleOptional

The hourly service rate.

householdIdstringOptionalformat: "uuid"

Required if maintenanceLocationType is UNIT.

isAlarmActivebooleanOptional

Indicates if the alarm is active.

isDoorCodeActivebooleanOptional

Indicates if the door code is active.

otherLocationDetailsstringOptional<=100 characters

previouslyReportedbooleanOptional

If the Issue was previously reported, this will be true.

readableIdstringOptional

requestedStartDateFromstringOptionalformat: "date"

requestedStartDateTostringOptionalformat: "date"

requestedStartTimeFromstringOptional

Time format string (HH:mm:ss or similar)

requestedStartTimeTostringOptional

Time format string (HH:mm:ss or similar)

requestorEmailstringOptionalformat: "email"<=100 characters

Email address of the person who requested the work. Optional. An empty or blank value is treated as no value. On update, sending an explicit null clears a previously stored value, while omitting the field leaves it unchanged. When a non-blank value is sent it must be a valid email address of at most 100 characters.

requestorNamestringOptional<=100 characters

requestorPhonestringOptional<=15 characters

Phone number of the person who requested the work. Optional. An empty or blank value is treated as no value. On update, sending an explicit null clears a previously stored value, while omitting the field leaves it unchanged. When a non-blank value is sent it must be at most 15 characters.

serviceNotesstringOptional<=500 characters

technicianNotesstringOptional

Notes to the technician.

totalAmountOwedByResidentdoubleOptional

The total amount owed by the resident.

totalCostOfMaterialsUseddoubleOptional

The total cost of materials used.

unitIdstringOptionalformat: "uuid"

Required if maintenanceLocationType is UNIT.

vendorNotesstringOptional<=500 characters

Response

Expected response to a valid request

statusenumOptional

priorityenumOptional

hasPetAlertbooleanOptional

completedAtdatetimeOptional

requestorPhonestringOptional

requestorEmailstringOptional

requestedStartDateFromstringOptionalformat: "date"

requestedStartDateTostringOptionalformat: "date"

requestedStartTimeFromstringOptional

requestedStartTimeTostringOptional

dueDatestringOptionalformat: "date"

descriptionstringOptional<=500 characters

serviceNotesstringOptional<=2000 characters

vendorNotesstringOptional<=2000 characters

entryNotesstringOptional<=500 characters

entryPreferenceenumOptional

isDoorCodeActivebooleanOptional

isAlarmActivebooleanOptional

doorCodestringOptional

alarmCodestringOptional

holdReasonstringOptional

otherLocationDetailstringOptional<=500 characters

attachmentIdsstringOptionalformat: "uuid"

technicianNotesstringOptional<=500 characters

Notes to the technician.

previouslyReportedbooleanOptional

If the Issue was previously reported, this will be true.

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtstringOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

assignedUserIdstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

customerIdstringOptionalformat: "uuid"

unitIdstringOptionalformat: "uuid"

maintenanceIssueIdstringOptionalformat: "uuid"

maintenanceLocationIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

totalCostOfMaterialsUseddoubleOptional

The total cost of materials used.

totalAmountOwedByResidentdoubleOptional

The total amount owed by the resident.

totalAmountOwedByPropertydoubleOptional

The total amount owed by the property.

hourlyServiceRatedoubleOptional

The hourly service rate.

totalLaborCostdoubleOptional

The total labor cost.