diff --git a/projects/prison-education-and-delius/README.md b/projects/prison-education-and-delius/README.md index ca69750635..619f28e402 100644 --- a/projects/prison-education-and-delius/README.md +++ b/projects/prison-education-and-delius/README.md @@ -1,3 +1,22 @@ -# prison-education-and-delius +# Prison Education and Delius -// TODO Describe the service \ No newline at end of file +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 | diff --git a/projects/prison-education-and-delius/tech-docs/diag/prison-education-context-map.d2 b/projects/prison-education-and-delius/tech-docs/diag/prison-education-context-map.d2 new file mode 100644 index 0000000000..401ef347d9 --- /dev/null +++ b/projects/prison-education-and-delius/tech-docs/diag/prison-education-context-map.d2 @@ -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 diff --git a/projects/prison-education-and-delius/tech-docs/source/img/prison-education-context-map.svg b/projects/prison-education-and-delius/tech-docs/source/img/prison-education-context-map.svg new file mode 100644 index 0000000000..f889307a58 --- /dev/null +++ b/projects/prison-education-and-delius/tech-docs/source/img/prison-education-context-map.svg @@ -0,0 +1,122 @@ +Delius ContextPrison Education ContextEntitiesPrison Education and DeliusEntitiesStaffPerson on ProbationOffender ManagerAddressAnti-CorruptionLayerPerson on ProbationAddressCommunity ManagerUpstream Downstream + + + + + + + + + + + + + + + +