Pre Consultation Question Templates
Function-calling namespace: preConsultationQuestionTemplates
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode. - Send token in header:
x-stack-access-token: <access_token>(orAuthorization: Bearer <access_token>). - In
optionalmode: no token is allowed; invalid token is rejected with401.
create
Source: backend/endpoints/pre-consultation-question-templates/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
platformDepartmentId | string | Yes | - |
questionText | string | Yes | - |
questionType | string | Yes | oneof: text |
isRequired | boolean | No | - |
isActive | boolean | No | - |
isDeleted | boolean | No | nullable |
createdAt | integer | No | unix-ms timestamp; nullable |
updatedAt | integer | No | unix-ms timestamp; nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "create",
"data": {
"platformDepartmentId": "org_123",
"questionText": "value",
"questionType": "text"
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/pre-consultation-question-templates/delete
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "delete",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/pre-consultation-question-templates/get-by-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "getById",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }getByPlatformDepartment
Source: backend/endpoints/pre-consultation-question-templates/get-by-platform-department
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
platformDepartmentId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "getByPlatformDepartment",
"data": {
"platformDepartmentId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByDepartment
Source: backend/endpoints/pre-consultation-question-templates/list-by-department
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
departmentId | string | Yes | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "listByDepartment",
"data": {
"departmentId": "department_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByOrganization
Source: backend/endpoints/pre-consultation-question-templates/list-by-organization
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "listByOrganization",
"data": {
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/pre-consultation-question-templates/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
platformDepartmentId | string | No | nullable |
questionText | string | No | nullable |
questionType | string | No | nullable |
isRequired | boolean | No | nullable |
orderIndex | integer | No | nullable |
version | integer | No | nullable |
isActive | boolean | No | nullable |
isDeleted | boolean | No | nullable |
createdAt | integer | No | unix-ms timestamp; nullable |
updatedAt | integer | No | unix-ms timestamp; nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "preConsultationQuestionTemplates",
"apiName": "update",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }