Your ideas allow us to crowdsource feedback, gain customer insight and prioritise our roadmaps.
Affected Resource:PATCH /api/medical/students/{schoolId}/conditions/{conditionId}
Current Documentation
Problem Statement:
Developers cannot reliably update student medical conditions due to:
Unclear required JSON format (RFC 6902 vs custom structure)
Missing field path specifications
No working examples for common updates
This results in failed integrations and unnecessary support tickets.
Proposed Documentation Changes:
Add Clear Request Format Examples
Include both minimal and full examples for:
jsonCopy
// Minimal working example [
{
"op": "replace",
"path": "/trigger",
"value": "Pollen exposure"
}
]
// Full field update example [
{
"op": "replace",
"path": "/trigger",
"value": "Test"
},
{
"op": "replace",
"path": "/treatment",
"value": "Antihistamines"
}
] Field Reference Table
Field Name |
JSON Path |
Data Type |
Required |
Trigger |
/trigger |
string |
No |
Type |
/type |
string |
Yes |
Group ID |
/groupId |
integer |
Yes |
Common Error Prevention
Add a troubleshooting section explaining:
When to use operations wrapper vs direct array
Purpose of the from property in PATCH requests
Date format requirements (ISO 8601 validation)
Thanks Kevin
Passing it as this works okay:-
[{"path":"severityId","value":2},{"path":"treatment","value":"Test1"},{"path":"trigger","value":"Impaired vision in left eye and needs glasses for reading"},{"path":"type","value":"Sight Impairment"}]
It seems I don't need "from" or "op" for it to work
Your API Documentation suggests the following example:-
https://developerdemo.isams.cloud/Main/swagger/ui/index#!/Medical_Centre_-_Student_Conditions/StudentConditions_UpdateBySchoolidConditionidPatch
{
"operations": [
{
"from": "string",
"op": "string",
"path": "string",
"value": {}
}
]
}
Which is confusing as it suggests its in a "operations" wrapper with no mention of what "from" and "op" meant to be set to. Proper examples like I have given you above would make your documentation more clearer.
This other documentation link below mentions nothing at all:-
Main API reference: Updates a medical condition for a student:-
https://developer.isams.com/isams-developer-documentation/reference/studentconditions_updatebyschoolidconditionidpatch
Developer Support 26/03/2025 at 12:58
I can confirm that the
operationsproperty is not required, you can pass in just the array without this, I will follow this up and see if the documentation needs to be updated or whether it is this particular API is different.Let me know how you get on.
Kind regards,
Kevin L