Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DFPL-2706 update schema for c110a chages #381

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

DFPL-2706 update schema for c110a chages #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc5beec
update schema
chak-shing-lo-justice Mar 10, 2025
024d9af
update description
chak-shing-lo-justice Mar 10, 2025
b86fe6a
Update fpl-cafcass-api.json
chak-shing-lo-justice Mar 10, 2025
b281ea4
Updated images
chak-shing-lo-justice Mar 10, 2025
a411e3a
Update fpl-cafcass-api.json
chak-shing-lo-justice Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/c4/images/structurizr-landscape.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
100 changes: 83 additions & 17 deletions docs/specs/fpl-cafcass-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,11 +313,16 @@
"addressUnknownReason": {
"type": "string",
"enum": [
"Whereabouts unknown",
"No fixed abode",
"Person deceased"
],
"description": "If the current address is not known, the reason why"
},
"addressUnknownDetails": {
"type": "string",
"description": "Details when Whereabouts unknown is selected"
},
"address": {
"$ref": "#/components/schemas/address",
"description": "Address of the respondent if address is known"
Expand Down Expand Up @@ -449,7 +454,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "(Deprecated)"
},
"emotionalHarmOccurrences": {
"type": "array",
Expand All @@ -459,7 +465,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "(Deprecated)"
},
"sexualAbuseOccurrences": {
"type": "array",
Expand All @@ -469,7 +476,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "(Deprecated)"
},
"neglectOccurrences": {
"type": "array",
Expand All @@ -479,7 +487,35 @@
"Future risk of harm",
"Past harm"
]
},
"description": "(Deprecated)"
},
"whatKindOfRiskAndHarmToChildren": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PHYSICAL_HARM",
"EMOTIONAL_HARM",
"SEXUAL_ABUSE",
"NEGLECT"
]
}
},
"factorsAffectingParenting": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ALCOHOL_DRUG_ABUSE",
"DOMESTIC_ABUSE",
"ANYTHING_ELSE"
]
}
},
"anythingElseAffectingParenting": {
"type": "string",
"description": "Fill in when factorsAffectingParenting is ANYTHING_ELSE"
}
}
},
Expand All @@ -488,43 +524,55 @@
"properties": {
"possibleCarer": {
"type": "boolean",
"description": "Are there any suitable carers outside of the UK?"
"description": "(Deprecated) Are there any suitable carers outside of the UK?"
},
"possibleCarerReason": {
"type": "string",
"description": "Filled in if possibleCarer = true"
"description": "(Deprecated) Filled in if possibleCarer = true"
},
"significantEvents": {
"type": "boolean",
"description": "Are you aware of any significant events that have happened outside the UK?"
"description": "(Deprecated) Are you aware of any significant events that have happened outside the UK?"
},
"significantEventsReason": {
"type": "string",
"description": "Filled in if significantEvents = true"
"description": "(Deprecated) Filled in if significantEvents = true"
},
"issues": {
"type": "boolean",
"description": "Are you aware of any issues with the jurisdiction of this case - for example under the Brussels 2 regulation?"
"description": "(Deprecated) Are you aware of any issues with the jurisdiction of this case - for example under the Brussels 2 regulation?"
},
"issuesReason": {
"type": "string",
"description": "Filled in if issues = true"
"description": "(Deprecated) Filled in if issues = true"
},
"proceedings": {
"type": "boolean",
"description": "Are you aware of any proceedings outside the UK?"
"description": "(Deprecated) Are you aware of any proceedings outside the UK?"
},
"proceedingsReason": {
"type": "string",
"description": "Filled in if proceedings = true"
"description": "(Deprecated) Filled in if proceedings = true"
},
"internationalAuthorityInvolvement": {
"type": "boolean",
"description": "Has, or should, a government or central authority in another country been involved in this case?"
"description": "(Deprecated) Has, or should, a government or central authority in another country been involved in this case?"
},
"internationalAuthorityInvolvementDetails": {
"type": "string",
"description": "Filled in if internationalAuthorityInvolvement = true"
"description": "(Deprecated) Filled in if internationalAuthorityInvolvement = true"
},
"whichCountriesInvolved": {
"type": "string",
"description": "Which other countries are involved?"
},
"outsideHagueConvention": {
"type": "boolean",
"description": "Are any of these countries outside of the Hague Convention?"
},
"importantDetails": {
"type": "string",
"description": "Provide all important details (Including any carers, events, proceedings or authorities outside the UK, or issues with jurisdiction.)"
}
}
},
Expand All @@ -542,15 +590,16 @@
"example": "2020-01-01"
},
"gender": {
"$ref": "#/components/schemas/gender"
"$ref": "#/components/schemas/gender",
"description": "(Deprecated)"
},
"genderIdentification": {
"type": "string",
"description": "Free text entry if gender is chosen as 'OTHER'"
"description": "(Deprecated) Free text entry if gender is chosen as 'OTHER'"
},
"birthPlace": {
"type": "string",
"description": "free text field"
"description": "(Deprecated) free text field"
},
"addressKnown": {
"type": "boolean",
Expand Down Expand Up @@ -761,6 +810,18 @@
},
"designated": {
"type": "boolean"
},
"representingDetails": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"description": "Details of the person representing when citizenIsApplicant is true"
}
}
},
Expand Down Expand Up @@ -792,6 +853,7 @@
"enum": [
"Living with respondents",
"Living with other family or friends",
"Living in a refuge",
"Removed by Police, powers ending soon",
"Voluntarily in section 20 care order",
"In hospital and soon to be discharged",
Expand All @@ -800,7 +862,7 @@
},
"livingSituationDetails": {
"type": "string",
"description": "Details of living situation if livingSituation equals other."
"description": "Details of living situation"
},
"address": {
"$ref": "#/components/schemas/address"
Expand All @@ -819,6 +881,10 @@
"type": "string",
"example": "11111222333"
},
"socialWorkerEmail": {
"type": "string",
"example": "[email protected]"
},
"additionalNeeds": {
"type": "boolean"
},
Expand Down