Start Work Order

PATCH

https://api.fortresstech.io/v1/workOrders/:workOrderId/start

PATCH

/v1/workOrders/:workOrderId/start

curl -X PATCH https://api.fortresstech.io/v1/workOrders/workOrderId/start \
     -H "x-api-key: <apiKey>"

200Updated

{
  "status": "OPEN",
  "priority": "LOW",
  "hasPetAlert": true,
  "completedAt": "2024-01-15T09:30:00Z",
  "requestorPhone": "string",
  "requestorEmail": "string",
  "requestedStartDateFrom": "2023-01-15",
  "requestedStartDateTo": "2023-01-15",
  "requestedStartTimeFrom": "string",
  "requestedStartTimeTo": "string",
  "dueDate": "2023-01-15",
  "description": "string",
  "serviceNotes": "string",
  "vendorNotes": "string",
  "entryNotes": "string",
  "entryPreference": "24_HOUR_NOTICE",
  "isDoorCodeActive": true,
  "isAlarmActive": true,
  "doorCode": "string",
  "alarmCode": "string",
  "holdReason": "string",
  "otherLocationDetail": "string",
  "attachmentIds": "string",
  "technicianNotes": "string",
  "previouslyReported": true,
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "assignedUserId": "string",
  "householdId": "string",
  "customerId": "string",
  "unitId": "string",
  "maintenanceIssueId": "string",
  "maintenanceLocationId": "string",
  "propertyId": "string",
  "organizationId": "string",
  "totalCostOfMaterialsUsed": 1.1,
  "totalAmountOwedByResident": 1.1,
  "totalAmountOwedByProperty": 1.1,
  "hourlyServiceRate": 1.1,
  "totalLaborCost": 1.1,
  "user": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "username": "string",
    "status": "ACTIVE",
    "hasAllProperties": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyIds": "string"
  },
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "string",
    "currentLeaseId": "string",
    "applicationId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "currentCertificationId": "string",
    "prospectId": "string",
    "primaryCustomerId": "string",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "string"
  },
  "customer": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "preferredName": "string",
    "suffix": "string",
    "birthDate": "2023-01-15",
    "status": "APPLICANT",
    "email": "string",
    "phone": "string",
    "gender": "string",
    "headOfHousehold": true,
    "relationship": "PARTNER",
    "passportNumberLastFour": "string",
    "passportCountry": "string",
    "alienRegistrationNumberLastFour": "string",
    "citizenshipStatus": "string",
    "maritalStatus": "string",
    "spouseName": "string",
    "studentType": "string",
    "currentAddressStreet": "string",
    "currentAddressStreet2": "string",
    "currentAddressCity": "string",
    "currentAddressState": "string",
    "currentAddressZipCode": "string",
    "lenderName": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "householdId": "string",
    "propertyId": "string",
    "organizationId": "string"
  },
  "unit": {
    "number": "string",
    "floorLevel": "string",
    "isADA": true,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "fullAddress": "string",
    "status": "VACANT_READY",
    "isOccupied": true,
    "floorPlanId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "buildingId": "string",
    "currentHouseholdId": "string",
    "lastMoveOutId": "string",
    "priorLeaseId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "vacantSince": "2024-01-15T09:30:00Z",
    "reportOrder": 1.1,
    "makeReadyDate": "2023-01-15",
    "reportConfigurationValue": "Quoting Rent",
    "lastVacancyStartDate": "2023-01-15",
    "mostRecentApplicationId": "string"
  },
  "maintenanceIssue": {
    "description": "string",
    "type": "UNIT",
    "id": "string",
    "organizationIssueId": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyId": "string",
    "categoryId": "string",
    "maintenanceLocationId": "string"
  },
  "maintenanceLocation": {
    "name": "string",
    "type": "UNIT",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "organizationId": "string",
    "propertyId": "string"
  },
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "attachments": [
    {
      "name": "string",
      "url": "string",
      "type": "ISSUE",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "workOrderId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "notes": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "deletedAt": "2024-01-15T09:30:00Z",
      "householdId": "string",
      "customerId": "string"
    }
  ]
}

Mark a work order with the status "In Progress"

Authentication

x-api-keystring

API Key authentication via header

Path parameters

workOrderIdstringRequiredformat: "uuid"

The id of the work order

Response

The updated work order

statusenumOptional

Allowed values:

priorityenumOptional

Allowed values:

hasPetAlertbooleanOptional

completedAtdatetimeOptional

requestorPhonestring or nullOptional

requestorEmailstring or nullOptionalformat: "emailAddress"

requestedStartDateFromdateOptional

requestedStartDateTodateOptional

requestedStartTimeFromstringOptional

requestedStartTimeTostringOptional

dueDatedateOptional

descriptionstringOptional<=500 characters

serviceNotesstringOptional<=2000 characters

vendorNotesstringOptional<=2000 characters

entryNotesstringOptional<=500 characters

entryPreferenceenumOptional

Allowed values:

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.

userobjectOptional

householdobjectOptional

customerobjectOptional

unitobjectOptional

maintenanceIssueobjectOptional

maintenanceLocationobjectOptional

propertyobjectOptional

attachmentslist of objectsOptional