schemas.meansassessment.apiMeansAssessmentRequest.json Maven / Gradle / Ivy

Go to download
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "apiMeansAssessmentRequest.json",
  "type": "object",
  "title": "Initial Means Assessment Request",
  "description": "Data contract for initial means assessment requests",
  "properties": {
    "laaTransactionId": {
      "type": "string",
      "description": "The txn / correlation UUID"
    },
    "repId": {
      "type": "integer",
      "description": "MAAT / Rep Id"
    },
    "cmuId": {
      "type": "integer",
      "description": "Case Management Unit Id"
    },
    "initialAssessmentDate": {
      "type": "string",
      "description": "Effective Date of initial assessment",
      "format": "date-time"
    },
    "otherBenefitNote": {
      "type": "string",
      "description": "Benefit Note"
    },
    "otherIncomeNote": {
      "type": "string",
      "description": "Income Note."
    },
    "employmentStatus": {
      "type": "string",
      "description": "Employment status code"
    },
    "initAssessmentNotes": {
      "type": "string",
      "description": "Initial assessment notes field."
    },
    "assessmentStatus": {
      "type": "object",
      "description": "Assessment Status",
      "existingJavaType": "uk.gov.justice.laa.crime.enums.CurrentStatus"
    },
    "sectionSummaries": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "common/apiAssessmentSectionSummary.json"
      }
    },
    "childWeightings": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "common/apiAssessmentChildWeighting.json"
      }
    },
    "hasPartner": {
      "type": "boolean",
      "description": "Indicates whether the applicant has a partner (used to check if partner weighting factor is applicable)"
    },
    "partnerContraryInterest": {
      "type": "boolean",
      "description": "Indicates whether the applicant's partner has a contrary interest' (used to check if partner weighting factor is applicable)"
    },
    "assessmentType": {
      "description": "Type of as Assessment - Initial, full etc.",
      "type": "object",
      "existingJavaType": "uk.gov.justice.laa.crime.enums.AssessmentType"
    },
    "caseType": {
      "type": "object",
      "description": "The case type",
      "existingJavaType": "uk.gov.justice.laa.crime.enums.CaseType"
    },
    "userSession": {
      "type": "object",
      "description": "The current users session",
      "$ref": "../common/apiUserSession.json"
    },
    "incomeEvidenceSummary": {
      "type": "object",
      "description": "Income Evidence Summary",
      "$ref": "common/apiIncomeEvidenceSummary.json"
    },
    "crownCourtOverview": {
      "type": "object",
      "description": "Crown court overview details",
      "$ref": "common/apiCrownCourtOverview.json"
    },
    "magCourtOutcome": {
      "type": "object",
      "description": "Magistrate Court Outcome",
      "existingJavaType": "uk.gov.justice.laa.crime.enums.MagCourtOutcome"
    },
    "newWorkReason": {
      "description": "Work Reason Details",
      "existingJavaType": "uk.gov.justice.laa.crime.enums.NewWorkReason"
    }
  },
  "additionalProperties": false,
  "required": [
    "laaTransactionId",
    "repId",
    "cmuId",
    "initialAssessmentDate",
    "employmentStatus",
    "assessmentStatus",
    "sectionSummaries",
    "childWeightings",
    "hasPartner",
    "partnerContraryInterest",
    "assessmentType",
    "caseType",
    "userSession",
    "crownCourtOverview"
  ]
}