From 6290f6004c1116118889edc027e1c61bc84126e0 Mon Sep 17 00:00:00 2001 From: baarkerlounger Date: Thu, 24 Feb 2022 17:40:20 +0000 Subject: [PATCH] Remove incorrect API doc info for now --- docs/api/DLUHC-CORE-Data.v1.json | 757 +++++++++++-------------------- 1 file changed, 265 insertions(+), 492 deletions(-) diff --git a/docs/api/DLUHC-CORE-Data.v1.json b/docs/api/DLUHC-CORE-Data.v1.json index 308220f9a..bb90d3fb4 100644 --- a/docs/api/DLUHC-CORE-Data.v1.json +++ b/docs/api/DLUHC-CORE-Data.v1.json @@ -54,7 +54,9 @@ { "schema": { "type": "string", - "enum": ["application/json"] + "enum": [ + "application/json" + ] }, "in": "header", "name": "Accept", @@ -107,7 +109,9 @@ "Invalid Age": { "value": { "errors": { - "age1": ["Tenant age must be between 16 and 120"] + "age1": [ + "Tenant age must be between 16 and 120" + ] } } } @@ -132,7 +136,9 @@ { "schema": { "type": "string", - "enum": ["application/json"] + "enum": [ + "application/json" + ] }, "in": "header", "name": "Accept", @@ -171,7 +177,9 @@ { "schema": { "type": "string", - "enum": ["application/json"] + "enum": [ + "application/json" + ] }, "in": "header", "name": "Accept", @@ -211,7 +219,9 @@ "reasonable_preference_reason": [ "If reasonable preference is Yes, a reason must be given" ], - "age1": ["Tenant age must be between 16 and 120"] + "age1": [ + "Tenant age must be between 16 and 120" + ] } } } @@ -237,7 +247,9 @@ "schema": { "type": "string", "pattern": "application/json", - "enum": ["application/json"] + "enum": [ + "application/json" + ] }, "in": "header", "name": "Accept", @@ -255,116 +267,152 @@ "type": "object", "x-examples": { "example-1": { - "tenant_code": "T657", - "age1": 35, - "sex1": "Female", - "ethnic": "White: English, Welsh, Scottish, Northern Irish or British", - "national": "UK national resident in UK", - "prevten": "Private sector tenancy", - "armedforces": "Yes, the person is a current or former regular", - "ecstat1": "Full-time - 30 hours or more", - "other_hhmemb": 7, - "relat2": "Partner", - "age2": 32, - "sex2": "Male", - "ecstat2": "Not seeking work", - "relat3": "Child - includes young adult and grown-up", - "age3": 12, - "sex3": "Male", - "ecstat3": "Child under 16", - "relat4": "Child - includes young adult and grown-up", - "age4": 12, - "sex4": "Female", - "ecstat4": "Child under 16", - "relat5": "Child - includes young adult and grown-up", - "age5": 10, - "sex5": "Non-binary", - "ecstat5": "Child under 16", - "relat6": "Child - includes young adult and grown-up", - "age6": 5, - "sex6": "Prefer not to say", - "ecstat6": "Child under 16", - "relat7": "Child - includes young adult and grown-up", - "age7": 5, - "sex7": "Prefer not to say", - "ecstat7": "Child under 16", - "relat8": "Child - includes young adult and grown-up", - "age8": 2, - "sex8": "Prefer not to say", - "ecstat8": "Child under 16", - "homeless": "No", - "reason": "Other problems with neighbours", - "underoccupation_benefitcap": "No", - "leftreg": "No", - "reservist": "No", - "illness": "Yes", - "preg_occ": "No", - "accessibility_requirements": "No", - "condition_effects": "dummy", - "tenancy_code": "BZ757", - "startdate": "12/03/2019", - "startertenancy": "No", - "tenancylength": "No", - "tenancy": "Secure (including flexible)", - "landlord": "This landlord", - "la": "Barnet", - "previous_postcode": "NW1 5TY", - "property_relet": "No", - "rsnvac": "Relet - tenant abandoned property", - "property_reference": "P9876", - "unittype_gn": "House", - "property_building_type": "dummy", - "beds": 3, - "property_void_date": "03/11/2019", - "majorrepairs": "No", - "mrcdate": "05/05/2020", - "offered": 2, - "wchair": true, - "earnings": 1000, - "incfreq": "Monthly", - "benefits": "Some", - "hb": "Universal Credit with housing element (excluding housing benefit)", - "period": "Weekly", - "brent": 200, - "scharge": 50, - "pscharge": 40, - "supcharg": 35, - "tcharge": 325, - "tshortfall": "Yes", - "layear": "1 year but under 2 years", - "lawaitlist": "Less than 1 year", - "prevloc": "Ashford", - "property_postcode": "SE2 6RT", - "reasonpref": "Yes", - "reasonable_preference_reason": "dummy", - "cbl": true, - "chr": false, - "cap": false, - "hbrentshortfall": "Yes", - "other_reason_for_leaving_last_settled_home": "Other reason", - "housingneeds_a": true, - "housingneeds_b": false, - "housingneeds_c": false, - "housingneeds_f": false, - "housingneeds_g": false, - "housingneeds_h": false, - "accessibility_requirements_prefer_not_to_say": false, - "illness_type_1": false, - "illness_type_2": true, - "illness_type_3": false, - "illness_type_4": false, - "illness_type_8": false, - "illness_type_5": false, - "illness_type_6": false, - "illness_type_7": false, - "illness_type_9": false, - "illness_type_10": false, - "condition_effects_prefer_not_to_say": false, - "rp_homeless": false, - "rp_insan_unsat": false, - "rp_medwel": false, - "rp_hardship": false, - "rp_dontknow": true + "case_log": { + "tenant_code": "T657", + "age1": 35, + "sex1": "F", + "ethnic": 0, + "national": 0, + "prevten": 6, + "armedforces": 0, + "armed_forces_partner": "", + "ecstat1": 1, + "other_hhmemb": 7, + "hhmemb": 8, + "relat2": 0, + "age2": 32, + "sex2": "M", + "ecstat2": 5, + "relat3": 1, + "age3": 12, + "sex3": "M", + "ecstat3": 8, + "relat4": 1, + "age4": 12, + "sex4": "F", + "ecstat4": 8, + "relat5": 1, + "age5": 10, + "sex5": "X", + "ecstat5": 8, + "relat6": 1, + "age6": 5, + "sex6": "R", + "ecstat6": 8, + "relat7": 1, + "age7": 5, + "sex7": "R", + "ecstat7": 8, + "relat8": 1, + "age8": 2, + "sex8": "R", + "ecstat8": 8, + "homeless": 2, + "reason": 1, + "underoccupation_benefitcap": 0, + "leftreg": 1, + "reservist": 0, + "illness": 1, + "preg_occ": 0, + "tenancy_code": "BZ757", + "startdate": "12/12/2021", + "day": 12, + "month": 12, + "year": 2021, + "startertenancy": 0, + "tenancylength": 5, + "tenancy": 3, + "landlord": "This landlord", + "la": "Barnet", + "property_postcode": "NW1 5TY", + "property_relet": 0, + "rsnvac": 0, + "property_reference": "P9876", + "unittype_gn": 2, + "property_building_type": "dummy", + "beds": 3, + "property_void_date": "10/10/2020", + "majorrepairs": 1, + "mrcdate": "11/11/2020", + "mrcday": 11, + "mrcmonth": 11, + "mrcyear": 2020, + "offered": 2, + "wchair": 1, + "net_income_known": 1, + "earnings": 150, + "incfreq": 0, + "benefits": 1, + "hb": 1, + "period": 0, + "brent": 200, + "scharge": 50, + "pscharge": 40, + "supcharg": 35, + "tcharge": 325, + "outstanding_amount": 1, + "layear": 2, + "lawaitlist": 1, + "prevloc": "E07000105", + "previous_postcode": "SE2 6RT", + "reasonpref": 1, + "cbl": 1, + "chr": 1, + "cap": 0, + "hbrentshortfall": 0, + "tshortfall": 12, + "other_reason_for_leaving_last_settled_home": null, + "housingneeds_a": 1, + "housingneeds_b": 0, + "housingneeds_c": 0, + "housingneeds_f": 0, + "housingneeds_g": 0, + "housingneeds_h": 0, + "accessibility_requirements_prefer_not_to_say": 0, + "illness_type_1": 0, + "illness_type_2": 1, + "illness_type_3": 0, + "illness_type_4": 0, + "illness_type_8": 0, + "illness_type_5": 0, + "illness_type_6": 0, + "illness_type_7": 0, + "illness_type_9": 0, + "illness_type_10": 0, + "condition_effects_prefer_not_to_say": 1, + "rp_homeless": 0, + "rp_insan_unsat": 0, + "rp_medwel": 0, + "rp_hardship": 0, + "rp_dontknow": 0, + "discarded_at": "05/05/2020", + "override_net_income_validation": "", + "property_owner_organisation": "", + "property_manager_organisation": "", + "rent_type": 0, + "intermediate_rent_product_name": "", + "needstype": 1, + "sale_completion_date": "01/01/2020", + "purchaser_code": "", + "propcode": "123", + "postcode": "a1", + "postcod2": "w3", + "ppostc1": "w3", + "ppostc2": "w3", + "first_time_property_let_as_social_housing": 0, + "unitletas": 1, + "builtype": 0, + "property_wheelchair_accessible": 1, + "void_or_renewal_date": "05/05/2020", + "renewal": 1, + "new_build_handover_date": "01/01/2019", + "has_benefits": 1, + "household_charge": 1, + "is_carehome": 1, + "chcharge": 6, + "letting_in_sheltered_accommodation": 0, + "declaration": 1 + } } }, "title": "Case Log", @@ -383,79 +431,32 @@ "sex1": { "type": "string", "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "enum": [ + "F: Female", + "M:Male", + "X:Non-binary", + "R:Refused" + ], + "maxLength": 1 }, "ethnic": { - "type": "string", - "minLength": 1, - "enum": [ - "White: English, Welsh, Scottish, Northern Irish or British", - "White: Irish", - "White: Gypsy or Irish Traveller", - "White: Other", - "Mixed: White and Black Caribbean", - "Mixed: White and Black African", - "Mixed: White and Asian", - "Mixed: Other", - "Asian or Asian British: Indian", - "Asian or Asian British: Pakistani", - "Asian or Asian British: Bangladeshi", - "Asian or Asian British: Chinese", - "Asian or Asian British: Other", - "Black: Caribbean", - "Black: African", - "Black: Other", - "Other Ethnic Group: Arab", - "Other Ethnic Group: Other", - "Prefer not to say" - ] + "type": "integer", + "minimum": 1, + "maximum": 18 }, "national": { - "type": "string", - "minLength": 1, - "enum": [ - "UK national resident in UK", - "A current or former reserve in the UK Armed Forces (excluding National Service)", - "UK national returning from residence overseas", - "Czech Republic", - "Estonia", - "Hungary", - "Latvia", - "Lithuania", - "Poland", - "Slovakia", - "Bulgaria", - "Romania", - "Ireland", - "Other EU Economic Area (EEA country)", - "Any other country", - "Prefer not to say" - ] + "type": "integer", + "minimum": 1, + "maximum": 17 }, "prevten": { - "type": "string", - "minLength": 1 + "type": "integer" }, "armedforces": { - "type": "string", - "minLength": 1 + "type": "integer" }, "ecstat1": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "other_hhmemb": { "type": "number", @@ -463,14 +464,8 @@ "maximum": 7 }, "relat2": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer", + "minimum": 1 }, "age2": { "type": "number", @@ -480,34 +475,13 @@ "sex2": { "type": "string", "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "maxLength": 1 }, "ecstat2": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "relat3": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "age3": { "type": "number", @@ -516,35 +490,13 @@ }, "sex3": { "type": "string", - "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "minLength": 1 }, "ecstat3": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "relat4": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "age4": { "type": "number", @@ -553,35 +505,13 @@ }, "sex4": { "type": "string", - "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "minLength": 1 }, "ecstat4": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "relat5": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "age5": { "type": "number", @@ -590,35 +520,13 @@ }, "sex5": { "type": "string", - "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "minLength": 1 }, "ecstat5": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "relat6": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "age6": { "type": "number", @@ -627,35 +535,13 @@ }, "sex6": { "type": "string", - "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "minLength": 1 }, "ecstat6": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "relat7": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "age7": { "type": "number", @@ -664,35 +550,13 @@ }, "sex7": { "type": "string", - "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "minLength": 1 }, "ecstat7": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "relat8": { - "type": "string", - "minLength": 1, - "enum": [ - "Partner", - "Child - includes young adult and grown-up", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "age8": { "type": "number", @@ -701,105 +565,37 @@ }, "sex8": { "type": "string", - "minLength": 1, - "enum": ["Female", "Male", "Non-binary", "Prefer not to say"] + "minLength": 1 }, "ecstat8": { - "type": "string", - "minLength": 1, - "enum": [ - "Part-time - Less than 30 hours", - "Full-time - 30 hours or more", - "In government training into work, such as New Deal", - "Jobseeker", - "Retired", - "Not seeking work", - "Full-time student", - "Unable to work because of long term sick or disability", - "Child under 16", - "Other", - "Prefer not to say" - ] + "type": "integer" }, "homeless": { - "type": "string", - "minLength": 1 + "type": "integer" }, "reason": { - "type": "string", - "minLength": 1, - "enum": [ - "Permanently decanted from another property owned by this landlord", - "Left home country as a refugee", - "Loss of tied accommodation", - "Domestic abuse", - "Relationship breakdown (non-violent) with partner", - "Asked to leave by family or friends", - "Racial harassment", - "Other problems with neighbours", - "Property unsuitable because of overcrowding", - "End of assured shorthold tenancy - no fault", - "End of assured shorthold tenancy - eviction or tenant at fault", - "End of fixed term tenancy - no fault", - "End of fixed term tenancy - eviction or tenant at fault", - "Repossession", - "Under occupation - offered incentive to downsize", - "Under occupation - no incentive", - "Property unsuitable because of ill health or disability", - "Property unsuitable because of poor condition", - "Couldn’t afford fees attached to renewing the tenancy", - "Couldn’t afford increase in rent", - "Couldn’t afford rent or mortgage - welfare reforms", - "Couldn’t afford rent or mortgage - employment", - "Couldn’t afford rent or mortgage - other", - "To move nearer to family, friends or school", - "To move nearer to work", - "To move to accommodation with support", - "To move to independent accommodation", - "Hate crime", - "Death of household member in last settled accommodation", - "Discharged from prison", - "Discharged from long stay hospital or similar institution", - "Other", - "Don’t know", - "Tenant prefers not to say" - ] + "type": "integer" }, "underoccupation_benefitcap": { - "type": "string", - "minLength": 1, - "enum": [ - "Yes - benefit cap", - "Yes - removal of the spare room subsidy", - "Yes - both", - "No", - "Don’t know", - "Prefer not to say" - ] + "type": "integer" }, "leftreg": { - "type": "string", - "minLength": 1 + "type": "integer" }, "reservist": { - "type": "string", - "minLength": 1 + "type": "integer" }, "illness": { - "type": "string", - "minLength": 1 + "type": "integer" }, "preg_occ": { - "type": "string", - "minLength": 1 + "type": "integer" }, "accessibility_requirements": { - "type": "string", - "minLength": 1 + "type": "integer" }, "condition_effects": { - "type": "string", - "minLength": 1 + "type": "integer" }, "tenancy_code": { "type": "string", @@ -807,28 +603,23 @@ }, "startdate": { "type": "string", - "minLength": 1 + "minLength": 1, + "format": "date" }, "startertenancy": { - "type": "string", - "minLength": 1 + "type": "integer" }, "tenancylength": { - "type": "string", - "minLength": 1, - "pattern": "((?!1|0)([0-9][0-9]))+" + "type": "integer" }, "tenancy": { - "type": "string", - "minLength": 1 + "type": "integer" }, "lettype": { - "type": "string", - "minLength": 1 + "type": "integer" }, "landlord": { - "type": "string", - "minLength": 1 + "type": "integer" }, "la": { "type": "string", @@ -839,70 +630,57 @@ "minLength": 1 }, "property_relet": { - "type": "string", - "minLength": 1 + "type": "integer" }, "rsnvac": { - "type": "string", - "minLength": 1 + "type": "integer" }, "property_reference": { "type": "string", "minLength": 1 }, "unittype_gn": { - "type": "string", - "minLength": 1 + "type": "integer" }, "property_building_type": { - "type": "string", - "minLength": 1 + "type": "integer" }, "beds": { "type": "number" }, "property_void_date": { "type": "string", - "minLength": 1 + "minLength": 1, + "format": "date" }, "majorrepairs": { - "type": "string", - "minLength": 1 + "type": "integer" }, "mrcdate": { "type": "string", - "minLength": 1 + "minLength": 1, + "format": "date" }, "offered": { "type": "number" }, "wchair": { - "type": "boolean" - }, - "earnings_known": { - "type": "string", - "minLength": 1, - "enum": ["Yes", "No", "Tenant prefers not to say"] + "type": "integer" }, "earnings": { "type": "number" }, "incfreq": { - "type": "string", - "minLength": 1 + "type": "integer" }, "benefits": { - "type": "string", - "minLength": 1, - "enum": ["All", "Some", "None", "Don’t know"] + "type": "integer" }, "hb": { - "type": "string", - "minLength": 1 + "type": "integer" }, "period": { - "type": "string", - "minLength": 1 + "type": "integer" }, "brent": { "type": "number" @@ -920,16 +698,13 @@ "type": "number" }, "tshortfall": { - "type": "string", - "minLength": 1 + "type": "number" }, "layear": { - "type": "string", - "minLength": 1 + "type": "integer" }, "lawaitlist": { - "type": "string", - "minLength": 1 + "type": "integer" }, "prevloc": { "type": "string", @@ -940,97 +715,96 @@ "minLength": 1 }, "reasonpref": { - "type": "string", - "minLength": 1 + "type": "integer" }, "reasonable_preference_reason": { "type": "string", "minLength": 1 }, "cbl": { - "type": "boolean" + "type": "integer" }, "chr": { - "type": "boolean" + "type": "integer" }, "cap": { - "type": "boolean" + "type": "integer" }, "hbrentshortfall": { - "type": "number" + "type": "integer" }, "other_reason_for_leaving_last_settled_home": { "type": "string", "minLength": 1 }, "housingneeds_a": { - "type": "boolean" + "type": "integer" }, "housingneeds_b": { - "type": "boolean" + "type": "integer" }, "housingneeds_c": { - "type": "boolean" + "type": "integer" }, "housingneeds_f": { - "type": "boolean" + "type": "integer" }, "housingneeds_g": { - "type": "boolean" + "type": "integer" }, "housingneeds_h": { - "type": "boolean" + "type": "integer" }, "accessibility_requirements_prefer_not_to_say": { - "type": "boolean" + "type": "integer" }, "illness_type_1": { - "type": "boolean" + "type": "integer" }, "illness_type_2": { - "type": "boolean" + "type": "integer" }, "illness_type_3": { - "type": "boolean" + "type": "integer" }, "illness_type_4": { - "type": "boolean" + "type": "integer" }, "illness_type_8": { - "type": "boolean" + "type": "integer" }, "illness_type_5": { - "type": "boolean" + "type": "integer" }, "illness_type_6": { - "type": "boolean" + "type": "integer" }, "illness_type_7": { - "type": "boolean" + "type": "integer" }, "illness_type_9": { - "type": "boolean" + "type": "integer" }, "illness_type_10": { - "type": "boolean" + "type": "integer" }, "condition_effects_prefer_not_to_say": { - "type": "boolean" + "type": "integer" }, "rp_homeless": { - "type": "boolean" + "type": "integer" }, "rp_insan_unsat": { - "type": "boolean" + "type": "integer" }, "rp_medwel": { - "type": "boolean" + "type": "integer" }, "rp_hardship": { - "type": "boolean" + "type": "integer" }, "rp_dontknow": { - "type": "boolean" + "type": "integer" }, "other_tenancy-type": { "type": "string", @@ -1149,8 +923,7 @@ "rp_medwel", "rp_hardship", "rp_dontknow", - "other_tenancy-type", - "earnings_known" + "other_tenancy-type" ] } }, @@ -1167,4 +940,4 @@ } } } -} +} \ No newline at end of file