Skip to content

DFPL-2706 update schema for c110a chages #381

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

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

DFPL-2706 update schema for c110a chages #381

Changes from all commits
Commits
Show all changes
15 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
87c6c4f
Merge branch 'master' into DFPL-2706
chak-shing-lo-justice Apr 1, 2025
de7f27f
Updated images
chak-shing-lo-justice Apr 1, 2025
9ccc226
Update fpl-cafcass-api.json
chak-shing-lo-justice Apr 1, 2025
ce5d787
Merge branch 'DFPL-2706' of https://github.com/hmcts/cnp-api-docs int…
chak-shing-lo-justice Apr 1, 2025
b10e67a
Update fpl-cafcass-api.json
chak-shing-lo-justice Apr 1, 2025
36596b9
Update fpl-cafcass-api.json
chak-shing-lo-justice Apr 1, 2025
b1c947e
Merge branch 'master' into DFPL-2706
chak-shing-lo-justice Jun 26, 2025
006a763
Update fpl-cafcass-api.json
chak-shing-lo-justice Jun 26, 2025
1f5b363
Updated images
chak-shing-lo-justice Jun 26, 2025
92153af
Merge branch 'master' into DFPL-2706
chak-shing-lo-justice Jul 25, 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
92 changes: 68 additions & 24 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 @@ -346,7 +351,7 @@
},
"contactDetailsHidden": {
"type": "boolean",
"description": "Do you need contact details hidden from other parties?"
"description": "Do you need contact details hidden from other parties? If true, the address or any contact details are confidential."
},
"contactDetailsHiddenReason": {
"type": "string",
Expand Down Expand Up @@ -449,7 +454,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "For new cases created after Feb 26, instead of marking \"future\" or \"past\" to each of the risk, our portal will only mark if there's any risk of physical harm, emotional harm, sexual harm or neglect. However, to minimise impact to the API, If physical harm is marked in the new cases, the API will mark both \"Future\" and \"Past\" to this field."
},
"emotionalHarmOccurrences": {
"type": "array",
Expand All @@ -459,7 +465,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "For new cases created after Feb 26, instead of marking \"future\" or \"past\" to each of the risk, our portal will only mark if there's any risk of physical harm, emotional harm, sexual harm or neglect. However, to minimise impact to the API, If emotional harem is marked in the new cases, the API will mark both \"Future\" and \"Past\" to this field."
},
"sexualAbuseOccurrences": {
"type": "array",
Expand All @@ -469,7 +476,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "For new cases created after Feb 26, instead of marking \"future\" or \"past\" to each of the risk, our portal will only mark if there's any risk of physical harm, emotional harm, sexual harm or neglect. However, to minimise impact to the API, If sexual harm is marked in the new cases, the API will mark both \"Future\" and \"Past\" to this field."
},
"neglectOccurrences": {
"type": "array",
Expand All @@ -479,7 +487,8 @@
"Future risk of harm",
"Past harm"
]
}
},
"description": "For new cases created after Feb 26, instead of marking \"future\" or \"past\" to each of the risk, our portal will only mark if there's any risk of physical harm, emotional harm, sexual harm or neglect. However, to minimise impact to the API, If neglect is marked in the new cases, the API will mark both \"Future\" and \"Past\" to this field."
}
}
},
Expand All @@ -488,35 +497,35 @@
"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",
Expand All @@ -525,6 +534,14 @@
"internationalAuthorityInvolvementDetails": {
"type": "string",
"description": "Filled in if internationalAuthorityInvolvement = true"
},
"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 +559,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 All @@ -559,11 +577,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": "Filled in if addressKnown == true"
Expand All @@ -586,7 +609,7 @@
},
"detailsHidden": {
"type": "boolean",
"description": "Do you need contact details hidden from other parties?"
"description": "Do you need contact details hidden from other parties? If true, the address or any contact details are confidential"
},
"detailsHiddenReason": {
"type": "string",
Expand Down Expand Up @@ -652,9 +675,10 @@
"type": "string",
"example": "01234567890"
},
"fullName": {
"name": {
"type": "string",
"example": "Joe Bloggs"
"example": "Joe Bloggs",
"description": "For new cases created after 13 Mar, name is shown as two separated field on the portal, firstName and lastName"
},
"mainContact": {
"type": "boolean"
Expand Down Expand Up @@ -761,6 +785,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 +828,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 +837,7 @@
},
"livingSituationDetails": {
"type": "string",
"description": "Details of living situation if livingSituation equals other."
"description": "(Optional) Details of living situation. e.g. who they are living with or any other details if provided"
},
"address": {
"$ref": "#/components/schemas/address"
Expand All @@ -809,7 +846,8 @@
"type": "string"
},
"detailsHidden": {
"type": "boolean"
"type": "boolean",
"description": "If true, the address or social worker details of this child are confidential."
},
"socialWorkerName": {
"type": "string",
Expand All @@ -819,6 +857,10 @@
"type": "string",
"example": "11111222333"
},
"socialWorkerEmail": {
"type": "string",
"example": "[email protected]"
},
"additionalNeeds": {
"type": "boolean"
},
Expand Down Expand Up @@ -1489,13 +1531,15 @@
"type": "boolean"
},
"alcoholDrugAbuseReason": {
"type": "string"
"type": "string",
"description": "(Deprecated)"
},
"domesticViolence": {
"type": "boolean"
},
"domesticViolenceReason": {
"type": "string"
"type": "string",
"description": "(Deprecated)"
},
"anythingElse": {
"type": "boolean"
Expand Down Expand Up @@ -1523,4 +1567,4 @@
}
}
}
}
}