|
Http Verb |
PATCH |
|---|---|
|
Url |
/work-orders/permits/r1/required/{permitRequiredId}/obtained/{permitObtainedId} |
|
Permissions required |
Permits View/Edit Permission:
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2026 W3 (FSM 24.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API logically update a obtained permit
It enforces these rules before update. If any check fails, it returns a domain validation error.
-
Field validation checks:
-
Permit required not null
-
Request date not null
-
-
Validates that the permit required associated exists
-
Work order editability – Rejects the request if:
-
Work order status is not OPEN, RELEASED, LOCKED, PARTIALLY_ACCOUNTED, or TO_RESCHEDULE
-
-
Due date must be after obtained date
Path Parameters
|
Field |
Note |
|---|---|
|
permitObtainedId |
The permit obtained Id to update |
Query String Parameters
None
Header Parameters
Default.
Request Body
|
Field |
Validations |
Note |
|---|---|---|
|
practiceCode |
Optional |
|
|
notes |
Optional |
|
|
requestDate |
Optional |
|
|
obtainedDate |
Optional |
|
|
dueDate |
Optional |
|
Response documentation
Response payload fields
No content.