Skip to content

Commit

Permalink
PI-2180: Add Prison Eduction and Delius docs (#4238)
Browse files Browse the repository at this point in the history
  • Loading branch information
mxco86 authored Sep 17, 2024
1 parent c407825 commit d027556
Show file tree
Hide file tree
Showing 3 changed files with 174 additions and 2 deletions.
23 changes: 21 additions & 2 deletions projects/prison-education-and-delius/README.md
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 |
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
Loading

0 comments on commit d027556

Please sign in to comment.