EndpointsPlatform Qualification Documents

Platform Qualification Documents

Function-calling namespace: platformQualificationDocuments

  • Base URL: https://api.aivida.in
  • Engine endpoint: POST /api
  • Auth: Stack token middleware enabled in optional mode.
  • Send token in header: x-stack-access-token: <access_token> (or Authorization: Bearer <access_token>).
  • In optional mode: no token is allowed; invalid token is rejected with 401.

create

Source: backend/endpoints/platform-qualification-documents/create

Input Fields

FieldTypeRequiredConstraints
qualificationLevelIdstringYes-
documentNamestringYesmax: 255
isMandatorybooleanNonullable
sortOrderintegerNo-

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

FieldTypeRequiredConstraints
idstringYes-

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

FieldTypeRequiredConstraints
idstringYes-

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

FieldTypeRequiredConstraints
qualificationIdstringYes-

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

FieldTypeRequiredConstraints
idstringYes-
documentNamestringNomax: 255; nullable
isMandatorybooleanNonullable
sortOrderintegerNonullable

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": {} }