Platform Service Categories
Function-calling namespace: platformServiceCategories
- 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-service-categories/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
name | string | Yes | - |
code | string | No | - |
type | string | Yes | - |
description | string | No | - |
imageUrl | string | No | - |
videoUrl | string | No | - |
isActive | boolean | No | nullable |
sortOrder | integer | No | - |
parentIds | array<string> | No | - |
organizationTypeIds | array<string> | No | - |
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": "platformServiceCategories",
"apiName": "create",
"data": {
"name": "value",
"type": "general"
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/platform-service-categories/delete
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | 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": "platformServiceCategories",
"apiName": "delete",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/platform-service-categories/get-by-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | No | - |
organizationId | string | 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": "platformServiceCategories",
"apiName": "getById",
"data": {
"organizationId": "org_123",
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }list
Source: backend/endpoints/platform-service-categories/list
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
type | string | No | - |
hasServicesWithPlatformCategoryId | string | No | - |
organizationTypeId | array<string> | No | - |
organizationTypeName | array<string> | No | - |
search | string | No | - |
sortBy | string | No | - |
sortOrder | string | No | - |
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": "platformServiceCategories",
"apiName": "list",
"data": {
"type": "general",
"hasServicesWithPlatformCategoryId": "hasserviceswithplatformcategory_123",
"organizationTypeId": "organizationtype_123",
"organizationTypeName": [
"value"
],
"search": "value",
"sortBy": "value"
}
}'Example Response
{ "status": "ok", "data": {} }listActive
Source: backend/endpoints/platform-service-categories/list-active
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationTypeIds | array<string> | No | - |
type | string | No | - |
search | string | 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": "platformServiceCategories",
"apiName": "listActive",
"data": {
"organizationTypeIds": [
"value"
],
"type": "general",
"search": "value"
}
}'Example Response
{ "status": "ok", "data": {} }listByOrganization
Source: backend/endpoints/platform-service-categories/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": "platformServiceCategories",
"apiName": "listByOrganization",
"data": {
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByParent
Source: backend/endpoints/platform-service-categories/list-by-parent
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
parentId | string | No | - |
search | string | No | - |
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": "platformServiceCategories",
"apiName": "listByParent",
"data": {
"parentId": "parent_123",
"search": "value",
"page": 1,
"pageSize": 1
}
}'Example Response
{ "status": "ok", "data": {} }listForLabServices
Source: backend/endpoints/platform-service-categories/list-for-lab-services
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
search | string | No | - |
type | string | No | - |
gender | array<string> | No | - |
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": "platformServiceCategories",
"apiName": "listForLabServices",
"data": {
"search": "value",
"type": "general",
"gender": [
"value"
],
"page": 1,
"pageSize": 1
}
}'Example Response
{ "status": "ok", "data": {} }listMedicineCategoryServices
Source: backend/endpoints/platform-service-categories/list-medicine-category-services
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationTypeIds | array<string> | No | - |
type | string | No | - |
search | string | 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": "platformServiceCategories",
"apiName": "listMedicineCategoryServices",
"data": {
"organizationTypeIds": [
"value"
],
"type": "general",
"search": "value"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/platform-service-categories/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
name | string | No | nullable |
code | string | No | nullable |
type | string | No | nullable |
description | string | No | nullable |
imageUrl | string | No | nullable |
videoUrl | string | No | nullable |
isActive | boolean | No | nullable |
sortOrder | integer | No | nullable |
parentIds | array<string> | No | - |
organizationTypeIds | array<string> | No | - |
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": "platformServiceCategories",
"apiName": "update",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }