RC_(GraphQL) Get DRACS Marriage Act details (DRACS 2.0)

1 Purpose
2 Key points
3 Specification
4 Authorize
5 Validate legal entity
6 Validate request
- 6.1 Validate $.id
7 Service logic

Purpose

This WS is designed to allow NHS employee with assigned appropriate scopes to get DRACS Marriage Act details.

Key points

This is a graphQl query method used in Administration panel only.
Only authenticated and authorized NHS employee with appropriate scope can get DRACS Marriage Act details.

Specification

  "Reads a single `DracsMarriageAct` using its globally unique ID."
  dracsMarriageAct(id: ID!): DracsMarriageAct

type DracsMarriageAct implements Node {
  id: ID!
  databaseId: UUID!
  arRegDate: Date
  arRegNumber: String
  opDate: Date
  arOpName: String
  regNumb: String
  composeDate: String
  composeOrg: String
  isRestore: Int
  husbandOldSurname: String
  husbandSurname: String
  husbandName: String
  husbandPatronymic: String
  husbandNumident: String
  husbandDateBirth: String
  husbandCitizenship: Int
  husbandCitizenshipAnother: String
  husbandDocType: String
  husbandDocName: String
  husbandSeriesNumb: String
  husbandDocDate: String
  husbandDocOrgName: String
  husbandBirthState: String
  husbandBirthRegion: String
  husbandBirthDistrict: String
  husbandBirthLocalityType: String
  husbandBirthLocality: String
  husbandState: String
  husbandRegion: String
  husbandDistrict: String
  husbandLocalityType: String
  husbandLocality: String
  husbandStreet: String
  husbandHouse: String
  husbandBuildingPart: String
  husbandBuildingPartType: String
  husbandApartment: String
  wifeOldSurname: String
  wifeSurname: String
  wifeName: String
  wifePatronymic: String
  wifeNumident: String
  wifeDateBirth: String
  wifeCitizenship: Int
  wifeCitizenshipAnother: String
  wifeDocType: String
  wifeDocName: String
  wifeSeriesNumb: String
  wifeDocDate: String
  wifeDocOrgName: String
  wifeBirthState: String
  wifeBirthRegion: String
  wifeBirthDistrict: String
  wifeBirthLocalityType: String
  wifeBirthLocality: String
  wifeState: String
  wifeRegion: String
  wifeDistrict: String
  wifeLocalityType: String
  wifeLocality: String
  wifeStreet: String
  wifeHouse: String
  wifeBuildingPart: String
  wifeBuildingPartType: String
  wifeApartment: String
}

Authorize

Verify the validity of access token
- Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
- in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'person:read')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: person:read') in case of invalid scope(s)

Validate legal entity

Extract client_id from token.
Check legal entity status (status = ACTIVE)
- In case of error - return 409 ('client_id refers to legal entity that is not active')
Check client type (type = NHS)
- In case of error - return 403 ('You don't have permission to access this resource')

Validate request

Validate $.id

Check id is ID from mimir.dracs_marriage_acts

in case of error, return 404, "Such Marriage Act doesn't exist"

Service logic

Get Marriage Act data from mimir.dracs_marriage_acts by id
Render a response according to specification.