ZiteLab App Backend REST API - Care Plan, Activity & Questionnaire (1.0.0)

Download OpenAPI specification:Download

API endpoints to fetch care plan, activity, and questionnaire details.

Get Care Plan

Retrieve care plan details based on user UUID, SSN, and activity ID.

Authorizations:

None

query Parameters

user_uuid required	string <uuid> The unique UUID of the user.
ssn required	string^[0-9]{3}-[0-9]{2}-[0-9]{4}$ The Social Security Number (SSN) of the user.
activity_id required	string The ID of the activity for which the care plan is requested.

Responses

Response samples

200

Content type

application/json

{"id": "235",
"title": "STANDARD",
"description": "None",
"code": "STANDARD",
"status": "ready",
"created": "2025-03-17 08:23:18",
"updated": "2025-03-17 08:23:18",
"due_datetime": "2025-06-15 08:23:18",
"schedule_datetime": "2025-03-17 08:23:18",
"careplan_metadata": "None",
"careplan_type": "STANDARD",
"subject": "19c5245f-89a8-49f8-b244-666b32adb92e",
"activity": [{"id": "e8cdd9b1-f230-43d9-80ca-8cc7799e3a55",
"act_order": "1",
"answer": { },
"careplan_id": "235",
"code": "STANDARD",
"created": "2025-03-17 08:23:18",
"questionnaire_id": "aimweight.json",
"schedule_datetime": "None",
"start_datetime": "2025-03-17 08:23:18",
"status": "ready",
"title": "STANDARD",
"updated": "2025-03-17 08:23:18"
}
]
}

Get Activity List

Retrieve a list of activities based on user UUID, SSN, and optional questionnaire ID and language.

Authorizations:

None

query Parameters

user_uuid required	string <uuid> The unique UUID of the user.
ssn required	string^[0-9]{3}-[0-9]{2}-[0-9]{4}$ The Social Security Number (SSN) of the user.
qnr_id	string The ID of the questionnaire (optional).
language	string The language preference for translated answers (optional).

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"act_order": "string",
"answer": "string",
"answer_json": { },
"answer_translated": { },
"careplan_id": "string",
"code": "string",
"created": "2019-08-24T14:15:22Z",
"end_datetime": "2019-08-24T14:15:22Z",
"questionnaire_id": "string",
"schedule_datetime": "string",
"status": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
}
]

Get Questionnaire

Retrieve questionnaire details based on the provided name.

Authorizations:

None

query Parameters

name

required

string

The name of the questionnaire file (e.g., questionnaireweight.json).

Responses

Response samples

200

Content type

application/json

{"id": "string",
"title": "string",
"versionId": "string",
"status": "string",
"lastUpdated": "2019-08-24T14:15:22Z",
"answers": { },
"pages": [{"id": "string",
"text": "string",
"fields": [{"id": "string",
"required": true,
"type": "string",
"widget_type": "string",
"text": [{"language": "string",
"text": "string"
}
]
}
]
}
]
}