Impairments
1. Get all impairments
Endpoint
GET /api/v1/profile/impairments
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "Impairments retrieved successfully",
"data": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"disabilities": [
{
"id": 1,
"key": "dis_v_0001",
"title": "Blindness",
"description": "Complete or partial loss of vision",
"position": 1,
"impairment_id": 1,
"selected": false,
"custom_value": null
},
{
"id": 2,
"key": "dis_v_0002",
"title": "Low Vision",
"description": "Significant visual impairment, but some sight remains",
"position": 2,
"impairment_id": 1,
"selected": false,
"custom_value": null
}
],
"solutions": [
{
"id": 1,
"key": "sol_v_0001",
"title": "Obstacle Avoidance \u2013 Guide Me Around Hazards",
"description": "Guide dogs are trained to help their handlers navigate safely by avoiding obstacles in their path, whether stationary or moving",
"field_type": "checkbox",
"position": 1,
"impairment_id": 1,
"selected": false,
"starred": false,
"custom_value": null
},
{
"id": 2,
"key": "sol_v_0002",
"title": "Environmental Awareness \u2013 Alert Me to Changes in Surroundings",
"description": "Service dogs can notify handlers of important environmental cues like oncoming traffic, curbs, stairs, or changes in surface level",
"field_type": "checkbox",
"position": 2,
"impairment_id": 1,
"selected": false,
"starred": false,
"custom_value": null
}
]
}
]
}
2. Get all user disabilities
Endpoint
GET /api/v1/profile/impairments/disabilities
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "User disabilities retrieved successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"disabilities": [
{
"id": 1,
"key": "dis_v_0001",
"title": "Blindness",
"description": "Complete or partial loss of vision",
"position": 1,
"impairment_id": 1,
"selected": false
},
{
"id": 2,
"key": "dis_v_0002",
"title": "Low Vision",
"description": "Significant visual impairment, but some sight remains",
"position": 2,
"impairment_id": 1,
"selected": false
}
]
}
]
}
}
3. Refresh user disabilities (mass)
Endpoint
PUT /api/v1/profile/impairments/disabilities
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Request Body
custom_disability is optional parameter.
{
"disability_ids": [1,2],
"custom_disability": "My custom disability description"
}
Response Body (200)
{
"message": "User disabilities updated successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"disabilities": [
{
"id": 1,
"key": "dis_v_0001",
"title": "Blindness",
"description": "Complete or partial loss of vision",
"position": 1,
"impairment_id": 1,
"selected": true
},
{
"id": 2,
"key": "dis_v_0002",
"title": "Low Vision",
"description": "Significant visual impairment, but some sight remains",
"position": 2,
"impairment_id": 1,
"selected": true
}
]
}
]
}
}
4. Add one user disability
Endpoint
POST /api/v1/profile/impairments/disabilities/{disabilityId}
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Request Body
custom_disability is optional parameter.
{
"custom_disability": "My custom disability description"
}
Response Body (200)
{
"message": "Disability added successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"disabilities": [
{
"id": 1,
"key": "dis_v_0001",
"title": "Blindness",
"description": "Complete or partial loss of vision",
"position": 1,
"impairment_id": 1,
"selected": true
},
{
"id": 2,
"key": "dis_v_0002",
"title": "Low Vision",
"description": "Significant visual impairment, but some sight remains",
"position": 2,
"impairment_id": 1,
"selected": true
}
]
}
]
}
}
5. Delete user disability
Endpoint
DELETE /api/v1/profile/impairments/disabilities/{disabilityId}
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "Disability removed successfully",
"data": {
"impairments": []
}
}
6. Add custom user disability
Endpoint
POST /api/v1/profile/impairments/disabilities/custom
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Request Body
{
"custom_disability": "My custom disability description"
}
Response Body (200)
{
"message": "Custom disability added successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"disabilities": [
{
"id": 1,
"key": "dis_v_0001",
"title": "Blindness",
"description": "Complete or partial loss of vision",
"position": 1,
"impairment_id": 1,
"selected": true
},
{
"id": 2,
"key": "dis_v_0002",
"title": "Low Vision",
"description": "Significant visual impairment, but some sight remains",
"position": 2,
"impairment_id": 1,
"selected": true
}
]
}
]
}
}
7. Delete custom user disability
Endpoint
DELETE /api/v1/profile/impairments/disabilities/custom
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "Custom disability added successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"disabilities": [
{
"id": 1,
"key": "dis_v_0001",
"title": "Blindness",
"description": "Complete or partial loss of vision",
"position": 1,
"impairment_id": 1,
"selected": true
},
{
"id": 2,
"key": "dis_v_0002",
"title": "Low Vision",
"description": "Significant visual impairment, but some sight remains",
"position": 2,
"impairment_id": 1,
"selected": true
}
]
}
]
}
}
8. Get all user solutions
Endpoint
GET /api/v1/profile/impairments/solutions
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "User solutions retrieved successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"solutions": [
{
"id": 1,
"key": "sol_v_0001",
"title": "Obstacle Avoidance \u2013 Guide Me Around Hazards",
"description": "Guide dogs are trained to help their handlers navigate safely by avoiding obstacles in their path, whether stationary or moving",
"field_type": "checkbox",
"position": 1,
"impairment_id": 1,
"selected": false,
"starred": false
},
{
"id": 2,
"key": "sol_v_0002",
"title": "Environmental Awareness \u2013 Alert Me to Changes in Surroundings",
"description": "Service dogs can notify handlers of important environmental cues like oncoming traffic, curbs, stairs, or changes in surface level",
"field_type": "checkbox",
"position": 2,
"impairment_id": 1,
"selected": false,
"starred": false
}
]
}
]
}
}
9. Get all starred user solutions
Endpoint
GET /api/v1/profile/impairments/solutions
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "User starred solutions retrieved successfully",
"data": {
"regular": [],
"custom": []
}
}
10. Add one user solution
Endpoint
POST /api/v1/profile/impairments/solutions/{disabilityId}
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Request Body
custom_value is optional parameter.
{
"custom_value": "Additional details about how my dog helps with thisuuu67",
"starred": false
}
Response Body (200)
{
"message": "Solution added successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"solutions": [
{
"id": 1,
"key": "sol_v_0001",
"title": "Obstacle Avoidance \u2013 Guide Me Around Hazards",
"description": "Guide dogs are trained to help their handlers navigate safely by avoiding obstacles in their path, whether stationary or moving",
"field_type": "checkbox",
"position": 1,
"impairment_id": 1,
"selected": false,
"starred": false
},
{
"id": 2,
"key": "sol_v_0002",
"title": "Environmental Awareness \u2013 Alert Me to Changes in Surroundings",
"description": "Service dogs can notify handlers of important environmental cues like oncoming traffic, curbs, stairs, or changes in surface level",
"field_type": "checkbox",
"position": 2,
"impairment_id": 1,
"selected": false,
"starred": false
}
]
}
]
}
}
11. Delete one user solution
Endpoint
DELETE /api/v1/profile/impairments/solutions/{disabilityId}
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "Solution removed successfully",
"data": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"solutions": [
{
"id": 1,
"key": "sol_v_0001",
"title": "Obstacle Avoidance \u2013 Guide Me Around Hazards",
"description": "Guide dogs are trained to help their handlers navigate safely by avoiding obstacles in their path, whether stationary or moving",
"field_type": "checkbox",
"position": 1,
"impairment_id": 1,
"selected": false,
"starred": false
},
{
"id": 2,
"key": "sol_v_0002",
"title": "Environmental Awareness \u2013 Alert Me to Changes in Surroundings",
"description": "Service dogs can notify handlers of important environmental cues like oncoming traffic, curbs, stairs, or changes in surface level",
"field_type": "checkbox",
"position": 2,
"impairment_id": 1,
"selected": false,
"starred": false
}
]
}
]
}
}
12. Toggle star in user solution
Endpoint
POST /api/v1/profile/impairments/solutions/{disabilityId}/star
Request Headers
{
"Authorization": "Bearer token here",
"X-API-Key": "123456789",
"Content-Type": "application/json"
}
Response Body (200)
{
"message": "Solution star toggled successfully",
"data": {
"starred": true,
"solutions": {
"impairments": [
{
"id": 1,
"key": "visual",
"title": "Visual",
"description": "Visual impairments including blindness, low-vision, and other sight-related conditions",
"position": 1,
"solutions": [
{
"id": 1,
"key": "sol_v_0001",
"title": "Obstacle Avoidance \u2013 Guide Me Around Hazards",
"description": "Guide dogs are trained to help their handlers navigate safely by avoiding obstacles in their path, whether stationary or moving",
"field_type": "checkbox",
"position": 1,
"impairment_id": 1,
"selected": false,
"starred": false
},
{
"id": 2,
"key": "sol_v_0002",
"title": "Environmental Awareness \u2013 Alert Me to Changes in Surroundings",
"description": "Service dogs can notify handlers of important environmental cues like oncoming traffic, curbs, stairs, or changes in surface level",
"field_type": "checkbox",
"position": 2,
"impairment_id": 1,
"selected": false,
"starred": false
}
]
}
]
}
}
}
30 April 2025