forked from alaress/schoolbox-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpastoral@record@update.yaml
More file actions
28 lines (27 loc) · 1.22 KB
/
Copy pathpastoral@record@update.yaml
File metadata and controls
28 lines (27 loc) · 1.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
patch:
operationId: pastoral.patchRecordUpdate
tags: [pastoral]
summary: Partially update a pastoral record
parameters:
- $ref: ../components/parameters/id.yaml
description: |
Updates an existing pastoral record with a partial set of changes for brevity, such as updating a heading without needing to specify everything about the pastoral record explicitly.
Only some fields are supported by this endpoint, described below. Any fields outside of this set are disregarded.
Any fields omitted remain unchanged. Note that for updating Pastoral Actions you need to enable the config setting in admin.
#### Availability
This is accessible only when Pastoral module is enabled.
#### Permission
This endpoint is available for:
* Users with Pastoral Moderator service permission
* Users with a role of Staff role type with Access Pastoral Care permission
responses:
'200':
description: Successfully updated a pastoral record
content:
application/json:
schema:
$ref: ../components/schemas/pastoral-partial-item.yaml
default:
$ref: ../components/responses/problem.yaml
requestBody:
$ref: ../components/requestBodies/pastoral-partial-item.yaml