docs(api): align coverage review contract
This commit is contained in:
@@ -143,6 +143,7 @@ Coverage review payload:
|
|||||||
Rules:
|
Rules:
|
||||||
|
|
||||||
- worker rating happens through `POST /client/coverage/reviews`
|
- worker rating happens through `POST /client/coverage/reviews`
|
||||||
|
- the same endpoint also supports `markAsFavorite` to add or remove a worker from business favorites
|
||||||
- blocking a worker is done through the same endpoint using `markAsBlocked`
|
- blocking a worker is done through the same endpoint using `markAsBlocked`
|
||||||
- dispatch ranking order is:
|
- dispatch ranking order is:
|
||||||
1. `CORE`
|
1. `CORE`
|
||||||
|
|||||||
@@ -96,14 +96,16 @@ Payload may include:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
"staffId": "uuid",
|
||||||
"assignmentId": "uuid",
|
"assignmentId": "uuid",
|
||||||
"rating": 4,
|
"rating": 4,
|
||||||
"comment": "Strong performance on the shift",
|
"feedback": "Strong performance on the shift",
|
||||||
|
"markAsFavorite": true,
|
||||||
"markAsBlocked": false
|
"markAsBlocked": false
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If `markAsBlocked` is `true`, backend blocks that worker for that business and rejects future apply or assign attempts until a later review sets `markAsBlocked: false`.
|
If `markAsFavorite` is `true`, backend adds that worker to the business favorites list. If `markAsFavorite` is `false`, backend removes them from that list. If `markAsBlocked` is `true`, backend blocks that worker for that business and rejects future apply or assign attempts until a later review sets `markAsBlocked: false`.
|
||||||
|
|
||||||
Swap-management rule:
|
Swap-management rule:
|
||||||
|
|
||||||
|
|||||||
@@ -92,14 +92,17 @@ Coverage-review request payload may also send:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
"staffId": "uuid",
|
||||||
"assignmentId": "uuid",
|
"assignmentId": "uuid",
|
||||||
"rating": 2,
|
"rating": 2,
|
||||||
"comment": "Worker left the shift early without approval",
|
"feedback": "Worker left the shift early without approval",
|
||||||
|
"markAsFavorite": false,
|
||||||
|
"issueFlags": ["LEFT_EARLY"],
|
||||||
"markAsBlocked": true
|
"markAsBlocked": true
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If `markAsBlocked` is `true`, backend adds that staff member to the business-level blocked list and future apply or assign attempts are rejected until a later review sends `markAsBlocked: false`.
|
If `markAsFavorite` is `true`, backend adds that worker to the business favorites list. If `markAsFavorite` is `false`, backend removes them from that list. If `markAsBlocked` is `true`, backend adds that staff member to the business-level blocked list and future apply or assign attempts are rejected until a later review sends `markAsBlocked: false`.
|
||||||
|
|
||||||
Swap-review routes:
|
Swap-review routes:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user