You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
944 lines
24 KiB
944 lines
24 KiB
3 years ago
|
{
|
||
|
"openapi": "3.0.0",
|
||
|
"info": {
|
||
2 years ago
|
"title": "DLUHC CORE Data Collection API",
|
||
3 years ago
|
"version": "1.0",
|
||
2 years ago
|
"description": "Submit social housing lettings and sales data (CORE)"
|
||
3 years ago
|
},
|
||
|
"servers": [
|
||
|
{
|
||
2 years ago
|
"url": "https://dluhc-core-staging.london.cloudapps.digital/logs",
|
||
3 years ago
|
"description": "Staging"
|
||
3 years ago
|
}
|
||
|
],
|
||
|
"paths": {
|
||
3 years ago
|
"/logs/:id": {
|
||
3 years ago
|
"parameters": [],
|
||
|
"get": {
|
||
|
"summary": "Get Case Log Info by Case Log ID",
|
||
|
"tags": [],
|
||
|
"responses": {
|
||
|
"200": {
|
||
|
"description": "OK",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"$ref": "#/components/schemas/Case-Log"
|
||
|
},
|
||
|
"examples": {}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"404": {
|
||
|
"description": "Not Found",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"type": "object",
|
||
|
"properties": {}
|
||
|
},
|
||
|
"examples": {
|
||
|
"Not found": {
|
||
|
"value": {
|
||
|
"error": "Case Log 67 not found"
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"operationId": "get-case_logs-case_logs-:id",
|
||
|
"description": "Retrieve data for a specific case log",
|
||
|
"parameters": [
|
||
|
{
|
||
|
"schema": {
|
||
|
"type": "string",
|
||
3 years ago
|
"enum": [
|
||
|
"application/json"
|
||
|
]
|
||
3 years ago
|
},
|
||
|
"in": "header",
|
||
|
"name": "Accept",
|
||
|
"required": true
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
"patch": {
|
||
|
"summary": "Update Case Log Information",
|
||
|
"operationId": "patch-case_logs-case_logs-:id",
|
||
|
"responses": {
|
||
|
"200": {
|
||
|
"description": "Case Log Updated",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"$ref": "#/components/schemas/Case-Log"
|
||
|
},
|
||
|
"examples": {}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"404": {
|
||
|
"description": "Not Found",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"type": "object",
|
||
|
"properties": {}
|
||
|
},
|
||
|
"examples": {
|
||
|
"Not found": {
|
||
|
"value": {
|
||
|
"error": "Case Log 67 not found"
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"422": {
|
||
|
"description": "Unprocessable Entity ",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"type": "object",
|
||
|
"properties": {}
|
||
|
},
|
||
|
"examples": {
|
||
|
"Invalid Age": {
|
||
|
"value": {
|
||
3 years ago
|
"errors": {
|
||
3 years ago
|
"age1": [
|
||
|
"Tenant age must be between 16 and 120"
|
||
|
]
|
||
3 years ago
|
}
|
||
3 years ago
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"description": "Update the information of an existing case log",
|
||
|
"requestBody": {
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"$ref": "#/components/schemas/Case-Log"
|
||
|
},
|
||
|
"examples": {}
|
||
|
}
|
||
|
},
|
||
|
"description": "Patch case log properties to update."
|
||
|
},
|
||
|
"parameters": [
|
||
|
{
|
||
|
"schema": {
|
||
|
"type": "string",
|
||
3 years ago
|
"enum": [
|
||
|
"application/json"
|
||
|
]
|
||
3 years ago
|
},
|
||
|
"in": "header",
|
||
|
"name": "Accept",
|
||
|
"required": true
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
"delete": {
|
||
|
"summary": "Delete a Case Log by Case Log ID",
|
||
|
"operationId": "delete-case_logs-:id",
|
||
|
"responses": {
|
||
|
"204": {
|
||
|
"description": "No Content"
|
||
|
},
|
||
|
"404": {
|
||
|
"description": "Not Found",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"type": "object",
|
||
|
"properties": {}
|
||
|
},
|
||
|
"examples": {
|
||
|
"Not found": {
|
||
|
"value": {
|
||
|
"error": "Case Log 67 not found"
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"description": "Delete a case log",
|
||
|
"parameters": [
|
||
|
{
|
||
|
"schema": {
|
||
|
"type": "string",
|
||
3 years ago
|
"enum": [
|
||
|
"application/json"
|
||
|
]
|
||
3 years ago
|
},
|
||
|
"in": "header",
|
||
|
"name": "Accept",
|
||
|
"required": true
|
||
|
}
|
||
|
]
|
||
|
}
|
||
|
},
|
||
3 years ago
|
"/logs": {
|
||
3 years ago
|
"post": {
|
||
|
"summary": "Create New Case Log",
|
||
|
"operationId": "post-caselog",
|
||
|
"responses": {
|
||
3 years ago
|
"201": {
|
||
3 years ago
|
"description": "Case Log Created",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"$ref": "#/components/schemas/Case-Log"
|
||
|
},
|
||
|
"examples": {}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"422": {
|
||
|
"description": "Unprocessable Entity ",
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"type": "object",
|
||
|
"properties": {}
|
||
|
},
|
||
|
"examples": {
|
||
3 years ago
|
"Invalid Age and Reasonable Preference": {
|
||
3 years ago
|
"value": {
|
||
3 years ago
|
"errors": {
|
||
|
"reasonable_preference_reason": [
|
||
|
"If reasonable preference is Yes, a reason must be given"
|
||
|
],
|
||
3 years ago
|
"age1": [
|
||
|
"Tenant age must be between 16 and 120"
|
||
|
]
|
||
3 years ago
|
}
|
||
3 years ago
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
},
|
||
|
"requestBody": {
|
||
|
"content": {
|
||
|
"application/json": {
|
||
|
"schema": {
|
||
|
"$ref": "#/components/schemas/Case-Log"
|
||
|
},
|
||
|
"examples": {}
|
||
|
}
|
||
|
},
|
||
|
"description": "Post the necessary fields for the API to create a new case log."
|
||
|
},
|
||
|
"description": "Create a new case log.",
|
||
|
"parameters": [
|
||
|
{
|
||
|
"schema": {
|
||
|
"type": "string",
|
||
|
"pattern": "application/json",
|
||
3 years ago
|
"enum": [
|
||
|
"application/json"
|
||
|
]
|
||
3 years ago
|
},
|
||
|
"in": "header",
|
||
|
"name": "Accept",
|
||
|
"required": true
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
"parameters": []
|
||
|
}
|
||
|
},
|
||
|
"components": {
|
||
|
"schemas": {
|
||
|
"Case-Log": {
|
||
|
"description": "",
|
||
|
"type": "object",
|
||
|
"x-examples": {
|
||
|
"example-1": {
|
||
3 years ago
|
"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",
|
||
3 years ago
|
"postcode_full": "NW1 5TY",
|
||
3 years ago
|
"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",
|
||
3 years ago
|
"ppostcode_full": "SE2 6RT",
|
||
3 years ago
|
"reasonpref": 1,
|
||
|
"cbl": 1,
|
||
|
"chr": 1,
|
||
|
"cap": 0,
|
||
3 years ago
|
"hbrentshortfall": 1,
|
||
3 years ago
|
"tshortfall": 12,
|
||
3 years ago
|
"reasonother": null,
|
||
3 years ago
|
"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",
|
||
3 years ago
|
"net_income_value_check": "",
|
||
3 years ago
|
"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,
|
||
3 years ago
|
"shelteredaccom": 0,
|
||
3 years ago
|
"declaration": 1
|
||
|
}
|
||
3 years ago
|
}
|
||
|
},
|
||
|
"title": "Case Log",
|
||
|
"x-internal": false,
|
||
|
"properties": {
|
||
|
"tenant_code": {
|
||
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"age1": {
|
||
3 years ago
|
"type": "number",
|
||
|
"description": "The age of the lead tenant",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex1": {
|
||
3 years ago
|
"type": "string",
|
||
|
"minLength": 1,
|
||
3 years ago
|
"enum": [
|
||
|
"F: Female",
|
||
|
"M:Male",
|
||
|
"X:Non-binary",
|
||
|
"R:Refused"
|
||
|
],
|
||
|
"maxLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ethnic": {
|
||
3 years ago
|
"type": "integer",
|
||
|
"minimum": 1,
|
||
|
"maximum": 18
|
||
3 years ago
|
},
|
||
3 years ago
|
"national": {
|
||
3 years ago
|
"type": "integer",
|
||
|
"minimum": 1,
|
||
|
"maximum": 17
|
||
3 years ago
|
},
|
||
3 years ago
|
"prevten": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"armedforces": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat1": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"other_hhmemb": {
|
||
3 years ago
|
"type": "number",
|
||
|
"minimum": 0,
|
||
|
"maximum": 7
|
||
|
},
|
||
3 years ago
|
"relat2": {
|
||
3 years ago
|
"type": "integer",
|
||
|
"minimum": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"age2": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex2": {
|
||
3 years ago
|
"type": "string",
|
||
|
"minLength": 1,
|
||
3 years ago
|
"maxLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat2": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"relat3": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"age3": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex3": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat3": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"relat4": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"age4": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex4": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat4": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"relat5": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"age5": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex5": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat5": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"relat6": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"age6": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex6": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat6": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"relat7": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"age7": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex7": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat7": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"relat8": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"age8": {
|
||
3 years ago
|
"type": "number",
|
||
|
"maximum": 120,
|
||
|
"minimum": 0
|
||
|
},
|
||
3 years ago
|
"sex8": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1
|
||
3 years ago
|
},
|
||
3 years ago
|
"ecstat8": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"homeless": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"reason": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"underoccupation_benefitcap": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"leftreg": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"reservist": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"preg_occ": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"accessibility_requirements": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"condition_effects": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"tenancy_code": {
|
||
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"startdate": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1,
|
||
|
"format": "date"
|
||
3 years ago
|
},
|
||
3 years ago
|
"startertenancy": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"tenancylength": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"tenancy": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"lettype": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"landlord": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"la": {
|
||
3 years ago
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"ppostcode_full": {
|
||
3 years ago
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
|
"property_relet": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"rsnvac": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"property_reference": {
|
||
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"unittype_gn": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"property_building_type": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"beds": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
|
"property_void_date": {
|
||
|
"type": "string",
|
||
3 years ago
|
"minLength": 1,
|
||
|
"format": "date"
|
||
3 years ago
|
},
|
||
3 years ago
|
"majorrepairs": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"mrcdate": {
|
||
3 years ago
|
"type": "string",
|
||
3 years ago
|
"minLength": 1,
|
||
|
"format": "date"
|
||
3 years ago
|
},
|
||
3 years ago
|
"offered": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"wchair": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"earnings": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"incfreq": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"benefits": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"hb": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"period": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"brent": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"scharge": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"pscharge": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"supcharg": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"tcharge": {
|
||
3 years ago
|
"type": "number"
|
||
|
},
|
||
3 years ago
|
"tshortfall": {
|
||
3 years ago
|
"type": "number"
|
||
3 years ago
|
},
|
||
3 years ago
|
"layear": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"lawaitlist": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"prevloc": {
|
||
3 years ago
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"postcode_full": {
|
||
3 years ago
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"reasonpref": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"reasonable_preference_reason": {
|
||
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"cbl": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"chr": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"cap": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"hbrentshortfall": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"other_reason_for_leaving_last_settled_home": {
|
||
|
"type": "string",
|
||
|
"minLength": 1
|
||
|
},
|
||
3 years ago
|
"housingneeds_a": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"housingneeds_b": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"housingneeds_c": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"housingneeds_f": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"housingneeds_g": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"housingneeds_h": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"accessibility_requirements_prefer_not_to_say": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_1": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_2": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_3": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_4": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_8": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_5": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_6": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_7": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_9": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"illness_type_10": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"condition_effects_prefer_not_to_say": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"rp_homeless": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"rp_insan_unsat": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"rp_medwel": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"rp_hardship": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
3 years ago
|
"rp_dontknow": {
|
||
3 years ago
|
"type": "integer"
|
||
3 years ago
|
},
|
||
|
"other_tenancy-type": {
|
||
|
"type": "string",
|
||
|
"example": "private tenancy"
|
||
3 years ago
|
}
|
||
|
},
|
||
|
"required": [
|
||
|
"tenant_code",
|
||
3 years ago
|
"age1",
|
||
|
"sex1",
|
||
|
"ethnic",
|
||
|
"national",
|
||
|
"prevten",
|
||
3 years ago
|
"armedforces",
|
||
3 years ago
|
"ecstat1",
|
||
3 years ago
|
"other_hhmemb",
|
||
3 years ago
|
"relat2",
|
||
|
"age2",
|
||
|
"sex2",
|
||
|
"ecstat2",
|
||
|
"relat3",
|
||
|
"age3",
|
||
|
"sex3",
|
||
|
"ecstat3",
|
||
|
"relat4",
|
||
|
"age4",
|
||
|
"sex4",
|
||
|
"ecstat4",
|
||
|
"relat5",
|
||
|
"age5",
|
||
|
"sex5",
|
||
|
"ecstat5",
|
||
|
"relat6",
|
||
|
"age6",
|
||
|
"sex6",
|
||
|
"ecstat6",
|
||
|
"relat7",
|
||
|
"age7",
|
||
|
"sex7",
|
||
|
"ecstat7",
|
||
|
"relat8",
|
||
|
"age8",
|
||
|
"sex8",
|
||
|
"ecstat8",
|
||
|
"homeless",
|
||
3 years ago
|
"reason",
|
||
3 years ago
|
"underoccupation_benefitcap",
|
||
|
"leftreg",
|
||
|
"reservist",
|
||
|
"illness",
|
||
|
"preg_occ",
|
||
3 years ago
|
"accessibility_requirements",
|
||
|
"condition_effects",
|
||
|
"tenancy_code",
|
||
3 years ago
|
"startdate",
|
||
|
"startertenancy",
|
||
|
"tenancylength",
|
||
|
"tenancy",
|
||
|
"lettype",
|
||
|
"landlord",
|
||
3 years ago
|
"la",
|
||
3 years ago
|
"ppostcode_full",
|
||
3 years ago
|
"property_relet",
|
||
3 years ago
|
"rsnvac",
|
||
3 years ago
|
"property_reference",
|
||
3 years ago
|
"unittype_gn",
|
||
3 years ago
|
"property_building_type",
|
||
3 years ago
|
"beds",
|
||
3 years ago
|
"property_void_date",
|
||
3 years ago
|
"majorrepairs",
|
||
3 years ago
|
"mrcdate",
|
||
3 years ago
|
"offered",
|
||
|
"wchair",
|
||
|
"earnings",
|
||
|
"incfreq",
|
||
|
"benefits",
|
||
3 years ago
|
"hb",
|
||
3 years ago
|
"period",
|
||
|
"brent",
|
||
|
"scharge",
|
||
|
"pscharge",
|
||
|
"supcharg",
|
||
|
"tcharge",
|
||
3 years ago
|
"tshortfall",
|
||
3 years ago
|
"layear",
|
||
|
"lawaitlist",
|
||
3 years ago
|
"prevloc",
|
||
3 years ago
|
"postcode_full",
|
||
3 years ago
|
"reasonpref",
|
||
3 years ago
|
"reasonable_preference_reason",
|
||
3 years ago
|
"cbl",
|
||
|
"chr",
|
||
|
"cap",
|
||
3 years ago
|
"hbrentshortfall",
|
||
3 years ago
|
"other_reason_for_leaving_last_settled_home",
|
||
3 years ago
|
"housingneeds_a",
|
||
|
"housingneeds_b",
|
||
|
"housingneeds_c",
|
||
|
"housingneeds_f",
|
||
|
"housingneeds_g",
|
||
|
"housingneeds_h",
|
||
3 years ago
|
"accessibility_requirements_prefer_not_to_say",
|
||
3 years ago
|
"illness_type_1",
|
||
|
"illness_type_2",
|
||
|
"illness_type_3",
|
||
|
"illness_type_4",
|
||
|
"illness_type_8",
|
||
|
"illness_type_5",
|
||
|
"illness_type_6",
|
||
|
"illness_type_7",
|
||
|
"illness_type_9",
|
||
|
"illness_type_10",
|
||
3 years ago
|
"condition_effects_prefer_not_to_say",
|
||
3 years ago
|
"rp_homeless",
|
||
|
"rp_insan_unsat",
|
||
|
"rp_medwel",
|
||
|
"rp_hardship",
|
||
|
"rp_dontknow",
|
||
3 years ago
|
"other_tenancy-type"
|
||
3 years ago
|
]
|
||
|
}
|
||
|
},
|
||
3 years ago
|
"securitySchemes": {
|
||
|
"API Key - 1": {
|
||
|
"name": "API Key",
|
||
|
"type": "apiKey",
|
||
|
"in": "query"
|
||
|
},
|
||
|
"API Key - 2": {
|
||
|
"name": "API Key",
|
||
|
"type": "apiKey",
|
||
|
"in": "query"
|
||
|
}
|
||
|
}
|
||
3 years ago
|
}
|
||
3 years ago
|
}
|