Read Work Order

GET

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

GET

/v1/workOrders/:workOrderId

$ curl -G https://api.fortresstech.io/v1/workOrders/workOrderId \
>      --data-urlencode fields=id,name,property.*,documents.type

200Retrieved

1 {
2   "alarmCode": "alarmCode",
3   "assignedUserId": "assignedUserId",
4   "attachmentIds": "attachmentIds",
5   "attachments": [
6     {
7       "name": "name",
8       "url": "url",
9       "type": "ISSUE",
10       "createdAt": "2024-01-15T09:30:00Z",
11       "updatedAt": "2024-01-15T09:30:00Z",
12       "workOrderId": "workOrderId",
13       "propertyId": "propertyId",
14       "organizationId": "organizationId",
15       "notes": "notes",
16       "id": "id",
17       "readableId": "readableId",
18       "idempotencyId": "idempotencyId",
19       "deletedAt": "2024-01-15T09:30:00Z",
20       "householdId": "householdId",
21       "customerId": "customerId"
22     }
23   ],
24   "completedAt": "2024-01-15T09:30:00Z",
25   "createdAt": "createdAt",
26   "customer": {
27     "firstName": "firstName",
28     "middleName": "middleName",
29     "lastName": "lastName",
30     "preferredName": "preferredName",
31     "suffix": "suffix",
32     "birthDate": "birthDate",
33     "status": "APPLICANT",
34     "email": "email",
35     "phone": "phone",
36     "gender": "gender",
37     "headOfHousehold": true,
38     "relationship": "PARTNER",
39     "id": "id",
40     "readableId": "readableId",
41     "idempotencyId": "idempotencyId",
42     "createdAt": "2024-01-15T09:30:00Z",
43     "updatedAt": "2024-01-15T09:30:00Z",
44     "deletedAt": "2024-01-15T09:30:00Z",
45     "householdId": "householdId",
46     "propertyId": "propertyId",
47     "organizationId": "organizationId"
48   },
49   "customerId": "customerId",
50   "deletedAt": "2024-01-15T09:30:00Z",
51   "description": "description",
52   "doorCode": "doorCode",
53   "dueDate": "dueDate",
54   "entryNotes": "entryNotes",
55   "entryPreference": "24_HOUR_NOTICE",
56   "hasPetAlert": true,
57   "holdReason": "holdReason",
58   "hourlyServiceRate": 1.1,
59   "household": {
60     "status": "APPLICANT",
61     "isUnderEviction": true,
62     "id": "id",
63     "readableId": "readableId",
64     "idempotencyId": "idempotencyId",
65     "createdAt": "2024-01-15T09:30:00Z",
66     "updatedAt": "2024-01-15T09:30:00Z",
67     "deletedAt": "2024-01-15T09:30:00Z",
68     "currentUnitId": "currentUnitId",
69     "currentLeaseId": "currentLeaseId",
70     "applicationId": "applicationId",
71     "organizationId": "organizationId",
72     "propertyId": "propertyId",
73     "currentCertificationId": "currentCertificationId",
74     "prospectId": "prospectId",
75     "primaryCustomerId": "primaryCustomerId",
76     "totalActiveRentAmount": 1.1,
77     "totalActiveSubsidyAmount": 1.1,
78     "totalActiveFeesAmount": 1.1,
79     "unitId": "unitId"
80   },
81   "householdId": "householdId",
82   "id": "id",
83   "idempotencyId": "idempotencyId",
84   "isAlarmActive": true,
85   "isDoorCodeActive": true,
86   "maintenanceIssue": {
87     "description": "description",
88     "type": "UNIT",
89     "id": "id",
90     "organizationIssueId": "organizationIssueId",
91     "readableId": "readableId",
92     "idempotencyId": "idempotencyId",
93     "createdAt": "2024-01-15T09:30:00Z",
94     "updatedAt": "2024-01-15T09:30:00Z",
95     "deletedAt": "2024-01-15T09:30:00Z",
96     "organizationId": "organizationId",
97     "propertyId": "propertyId",
98     "categoryId": "categoryId",
99     "maintenanceLocationId": "maintenanceLocationId"
100   },
101   "maintenanceIssueId": "maintenanceIssueId",
102   "maintenanceLocation": {
103     "name": "name",
104     "type": "UNIT",
105     "id": "id",
106     "readableId": "readableId",
107     "idempotencyId": "idempotencyId",
108     "createdAt": "2024-01-15T09:30:00Z",
109     "updatedAt": "2024-01-15T09:30:00Z",
110     "deletedAt": "2024-01-15T09:30:00Z",
111     "organizationId": "organizationId",
112     "propertyId": "propertyId"
113   },
114   "maintenanceLocationId": "maintenanceLocationId",
115   "organizationId": "organizationId",
116   "otherLocationDetail": "otherLocationDetail",
117   "previouslyReported": true,
118   "priority": "LOW",
119   "property": {
120     "name": "name",
121     "shortName": "shortName",
122     "email": "email",
123     "phone": "phone",
124     "physicalStreetAddress1": "physicalStreetAddress1",
125     "physicalStreetAddress2": "physicalStreetAddress2",
126     "physicalCity": "physicalCity",
127     "physicalState": "physicalState",
128     "physicalZip": "physicalZip",
129     "physicalCountry": "physicalCountry",
130     "mailingStreetAddress1": "mailingStreetAddress1",
131     "mailingStreetAddress2": "mailingStreetAddress2",
132     "mailingCity": "mailingCity",
133     "mailingState": "mailingState",
134     "mailingZip": "mailingZip",
135     "mailingCountry": "mailingCountry",
136     "phoneNumber": "phoneNumber",
137     "faxNumber": "faxNumber",
138     "timezone": "timezone",
139     "longitude": 1.1,
140     "latitude": 1.1,
141     "turnMoveOutDays": 1,
142     "status": "ACTIVE",
143     "propertyClass": "Conventional",
144     "organizationId": "organizationId",
145     "id": "id",
146     "readableId": "readableId",
147     "idempotencyId": "idempotencyId",
148     "createdAt": "2024-01-15T09:30:00Z",
149     "updatedAt": "2024-01-15T09:30:00Z",
150     "deletedAt": "2024-01-15T09:30:00Z",
151     "offboardedAt": "2024-01-15T09:30:00Z",
152     "countyName": "countyName",
153     "acquisitionDate": "2024-01-15T09:30:00Z"
154   },
155   "propertyId": "propertyId",
156   "readableId": "readableId",
157   "requestedStartDateFrom": "requestedStartDateFrom",
158   "requestedStartDateTo": "requestedStartDateTo",
159   "requestedStartTimeFrom": "requestedStartTimeFrom",
160   "requestedStartTimeTo": "requestedStartTimeTo",
161   "requestorEmail": "requestorEmail",
162   "requestorPhone": "requestorPhone",
163   "serviceNotes": "serviceNotes",
164   "status": "OPEN",
165   "technicianNotes": "technicianNotes",
166   "totalAmountOwedByProperty": 1.1,
167   "totalAmountOwedByResident": 1.1,
168   "totalCostOfMaterialsUsed": 1.1,
169   "totalLaborCost": 1.1,
170   "unit": {
171     "number": "number",
172     "floorLevel": "floorLevel",
173     "isADA": true,
174     "streetAddress1": "streetAddress1",
175     "streetAddress2": "streetAddress2",
176     "city": "city",
177     "state": "state",
178     "zipCode": "zipCode",
179     "fullAddress": "fullAddress",
180     "status": "VACANT_READY",
181     "isOccupied": true,
182     "floorPlanId": "floorPlanId",
183     "propertyId": "propertyId",
184     "organizationId": "organizationId",
185     "buildingId": "buildingId",
186     "currentHouseholdId": "currentHouseholdId",
187     "lastMoveOutId": "lastMoveOutId",
188     "priorLeaseId": "priorLeaseId",
189     "id": "id",
190     "readableId": "readableId",
191     "idempotencyId": "idempotencyId",
192     "createdAt": "2024-01-15T09:30:00Z",
193     "updatedAt": "2024-01-15T09:30:00Z",
194     "deletedAt": "2024-01-15T09:30:00Z",
195     "vacantSince": "2024-01-15T09:30:00Z",
196     "reportOrder": 1.1,
197     "makeReadyDate": "makeReadyDate",
198     "reportConfigurationValue": "Quoting Rent",
199     "lastVacancyStartDate": "lastVacancyStartDate",
200     "mostRecentApplicationId": "mostRecentApplicationId"
201   },
202   "unitId": "unitId",
203   "updatedAt": "2024-01-15T09:30:00Z",
204   "user": {
205     "firstName": "firstName",
206     "lastName": "lastName",
207     "email": "email",
208     "username": "username",
209     "status": "ACTIVE",
210     "hasAllProperties": true,
211     "id": "id",
212     "readableId": "readableId",
213     "idempotencyId": "idempotencyId",
214     "createdAt": "2024-01-15T09:30:00Z",
215     "updatedAt": "2024-01-15T09:30:00Z",
216     "deletedAt": "2024-01-15T09:30:00Z",
217     "organizationId": "organizationId",
218     "propertyIds": "propertyIds"
219   },
220   "vendorNotes": "vendorNotes"
221 }

Info for a specific work order

Path parameters

workOrderIdstringRequired

The id of the work order

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

alarmCodestringOptional

assignedUserIdstringOptionalformat: "uuid"

attachmentIdsstringOptionalformat: "uuid"

attachmentslist of objectsOptional

completedAtdatetimeOptional

createdAtstringOptional

customerobjectOptional

customerIdstringOptionalformat: "uuid"

deletedAtdatetimeOptional

descriptionstringOptional<=500 characters

doorCodestringOptional

dueDatestringOptionalformat: "date"

entryNotesstringOptional<=500 characters

entryPreferenceenumOptional

hasPetAlertbooleanOptional

holdReasonstringOptional

hourlyServiceRatedoubleOptional

The hourly service rate.

householdobjectOptional

householdIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

isAlarmActivebooleanOptional

isDoorCodeActivebooleanOptional

maintenanceIssueobjectOptional

maintenanceIssueIdstringOptionalformat: "uuid"

maintenanceLocationobjectOptional

maintenanceLocationIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

otherLocationDetailstringOptional<=500 characters

previouslyReportedbooleanOptional

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

priorityenumOptional

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

readableIdstringOptional

requestedStartDateFromstringOptionalformat: "date"

requestedStartDateTostringOptionalformat: "date"

requestedStartTimeFromstringOptional

requestedStartTimeTostringOptional

requestorEmailstringOptional

requestorPhonestringOptional

serviceNotesstringOptional<=2000 characters

statusenumOptional

technicianNotesstringOptional<=500 characters

Notes to the technician.

totalAmountOwedByPropertydoubleOptional

The total amount owed by the property.

totalAmountOwedByResidentdoubleOptional

The total amount owed by the resident.

totalCostOfMaterialsUseddoubleOptional

The total cost of materials used.

totalLaborCostdoubleOptional

The total labor cost.

unitobjectOptional

unitIdstringOptionalformat: "uuid"

updatedAtdatetimeOptional

userobjectOptional

vendorNotesstringOptional<=2000 characters