Platform Qualification Documents
Function-calling namespace: platformQualificationDocuments
- 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/platform-qualification-documents/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
qualificationLevelId | string | Yes | - |
documentName | string | Yes | max: 255 |
isMandatory | boolean | No | nullable |
sortOrder | 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": "platformQualificationDocuments",
"apiName": "create",
"data": {
"qualificationLevelId": "qualificationlevel_123",
"documentName": "value"
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/platform-qualification-documents/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": "platformQualificationDocuments",
"apiName": "delete",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/platform-qualification-documents/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": "platformQualificationDocuments",
"apiName": "getById",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByQualification
Source: backend/endpoints/platform-qualification-documents/list-by-qualification
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
qualificationId | 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": "platformQualificationDocuments",
"apiName": "listByQualification",
"data": {
"qualificationId": "qualification_123"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/platform-qualification-documents/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
documentName | string | No | max: 255; nullable |
isMandatory | boolean | No | nullable |
sortOrder | integer | No | 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": "platformQualificationDocuments",
"apiName": "update",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }