generated from ministryofjustice/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PI-2180: Add Prison Eduction and Delius docs
- Loading branch information
Showing
3 changed files
with
174 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,22 @@ | ||
# prison-education-and-delius | ||
# Prison Education and Delius | ||
|
||
// TODO Describe the service | ||
Prison Education is a DPS service that pulls together existing prisoner data related to activities and education, and also the creation of a work readiness profile for a prisoner. This profile is created and used by a Prison Education Lead to prepare an offender leaving prison to gain employment. | ||
|
||
## Business Need | ||
|
||
To provide the Prison Education system with background information from the probation systems, allowing better matching of candidates to potential work opportunities. | ||
|
||
## Context Map | ||
|
||
![Context Map](./tech-docs/source/img/prison-education-context-map.svg) | ||
|
||
## Interfaces | ||
|
||
### API Access Control | ||
|
||
API endpoints are secured by roles supplied by the HMPPS Auth client used in | ||
the requests | ||
|
||
| API Endpoint | Required Role | | ||
|--------------|-------------------------------------------------------| | ||
| All | ROLE_PROBATION\_API_\_PRISON\_EDUCATION_\_CASE_DETAIL | |
31 changes: 31 additions & 0 deletions
31
projects/prison-education-and-delius/tech-docs/diag/prison-education-context-map.d2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
style { ...@../../../../script/style.style } | ||
vars { ...@../../../../script/style.vars } | ||
** { ...@../../../../script/style.all-style } | ||
|
||
context-delius: Delius Context { | ||
|
||
entities: Entities { | ||
grid-columns: 3 | ||
staff: Staff | ||
pop: Person on Probation | ||
offender-manager: Offender Manager | ||
address: Address | ||
} | ||
|
||
|
||
interface: Prison Education\n and Delius { | ||
type: Anti-Corruption\nLayer | ||
} | ||
} | ||
|
||
context-prison-education: Prison Education Context { | ||
entities: Entities { | ||
grid-columns: 3 | ||
pop: Person on Probation | ||
address: Address | ||
community-manager: Community Manager | ||
} | ||
} | ||
|
||
context-delius.interface--context-prison-education: Upstream\n\n\nDownstream |
Oops, something went wrong.