Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 502 Bytes

NAMING_CONVENTION.md

File metadata and controls

25 lines (15 loc) · 502 Bytes

hmpps-welcome-people-into-prison-api Naming Convention

When you build any object please follow this naming convention

Prison Number - string

prisonNumber

@Deprecated
offenderId - it can be used only in PrisonApiClient
prisonerNumber

Prison Id - string

prisonId

@Deprecated
agencyId

Arrival Id - string

arrivalId

Within the WPIP Domain, we refer to arrivalId. This can reflect ID's in other Domains which have their own term i.e. movementId/moveId for BASM.