EndpointsDoctor Profiles

Doctor Profiles

Function-calling namespace: doctorProfiles

  • 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/doctor-profiles/create

Input Fields

FieldTypeRequired
userIdstringYes
organizationIdstringYes
departmentIdstringNo
specializationstringYes
qualificationstringNo
experience*intNo
biostringNo
languages[]stringNo
conditions[]stringNo
consultationFee*float64No
genderstringNo
registrationNumberstringNo
isAvailableForOnline*boolNo
weeklySchedule[]models.DoctorWeeklyScheduleSlotNo
slotDuration*intNo
profileImageIdstringNo
profileImageUrlstringNo
education[]models.DoctorEducationNo
awards[]stringNo
phonestringNo
addressstringNo
isVerified*boolNo
verifiedAt*int64No
documents[]models.DoctorDocumentNo

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": "doctorProfiles",
  "apiName": "create",
  "data": {
    "userId": "user_123",
    "organizationId": "org_123",
    "specialization": "value"
  }
}'

Example Response

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

delete

Source: backend/endpoints/doctor-profiles/delete

Input Fields

FieldTypeRequired
idstringYes
organizationIdstringYes

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": "doctorProfiles",
  "apiName": "delete",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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

getById

Source: backend/endpoints/doctor-profiles/get-by-id

Input Fields

FieldTypeRequired
idstringYes
organizationIdstringYes

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": "doctorProfiles",
  "apiName": "getById",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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

listByOrganization

Source: backend/endpoints/doctor-profiles/list-by-organization

Input Fields

FieldTypeRequired
organizationIdstringYes
pageintNo
pageSizeintNo

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

Example Response

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

update

Source: backend/endpoints/doctor-profiles/update

Input Fields

FieldTypeRequired
idstringYes
organizationIdstringYes
userId*stringNo
departmentId*stringNo
specialization*stringNo
qualification*stringNo
experience*intNo
bio*stringNo
languages*[]stringNo
conditions*[]stringNo
consultationFee*float64No
gender*stringNo
registrationNumber*stringNo
isAvailableForOnline*boolNo
weeklySchedule*[]models.DoctorWeeklyScheduleSlotNo
slotDuration*intNo
profileImageId*stringNo
profileImageUrl*stringNo
education*[]models.DoctorEducationNo
awards*[]stringNo
phone*stringNo
address*stringNo
isVerified*boolNo
verifiedAt*int64No
documents*[]models.DoctorDocumentNo

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": "doctorProfiles",
  "apiName": "update",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

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