EndpointsConsultation Reviews

Consultation Reviews

Function-calling namespace: consultationReviews

  • 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.

getByConsultationId

Source: backend/endpoints/consultation-reviews/get-by-consultation-id

Input Fields

FieldTypeRequiredConstraints
organizationIdstringYes-
consultationIdstringYes-
actorStackUserIdstringNo-

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": "consultationReviews",
  "apiName": "getByConsultationId",
  "data": {
    "organizationId": "org_123",
    "consultationId": "consultation_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

listByDoctor

Source: backend/endpoints/consultation-reviews/list-by-doctor

Input Fields

FieldTypeRequiredConstraints
organizationIdstringYes-
doctorIdstringYes-
pageintegerNo-
pageSizeintegerNo-

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": "consultationReviews",
  "apiName": "listByDoctor",
  "data": {
    "organizationId": "org_123",
    "doctorId": "doctor_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

listByOrganization

Source: backend/endpoints/consultation-reviews/list-by-organization

Input Fields

FieldTypeRequiredConstraints
organizationIdstringYes-
doctorIdstringNo-
patientIdstringNo-
ratingintegerNo-
minRatingintegerNo-
maxRatingintegerNo-
reviewTagIdsarray<string>No-
searchstringNo-
pageintegerNo-
pageSizeintegerNo-

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": "consultationReviews",
  "apiName": "listByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

listPendingForPatient

Source: backend/endpoints/consultation-reviews/list-pending-for-patient

Input Fields

FieldTypeRequiredConstraints
organizationIdstringYes-
actorStackUserIdstringNo-
pageintegerNo-
pageSizeintegerNo-

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": "consultationReviews",
  "apiName": "listPendingForPatient",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

submit

Source: backend/endpoints/consultation-reviews/submit

Input Fields

FieldTypeRequiredConstraints
organizationIdstringNo-
consultationIdstringNo-
ratingintegerYesmin: 1; max: 5
feedbackstringNo-
patientIdstringYes-
doctorIdstringYes-
reviewTagIdsarray<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": "consultationReviews",
  "apiName": "submit",
  "data": {
    "rating": 1,
    "patientId": "patient_123",
    "doctorId": "doctor_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }