Recurso

Suscripciones

11 operaciones · base https://api.bestdoctorsrd.com

GET/v1/admin/plans

List Plans

Parámetros

NombreEnTipoObl.
pagequeryintegerNo
page_sizequeryintegerNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaPagedResponse_PlanOut_
422Error de validaciónHTTPValidationError
POST/v1/admin/plans

Create Plan

Cuerpo obligatorio PlanCreate

CampoTipoObl.
codestring
namestring
monthly_price_centsintegerNo
annual_price_centsintegerNo
module_keyslista de string
max_branchesintegerNo
max_usersintegerNo
max_doctorsintegerNo
max_patientsintegerNo
is_activebooleanNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaPlanOut
422Error de validaciónHTTPValidationError
PATCH/v1/admin/plans/{plan_id}

Update Plan

Parámetros

NombreEnTipoObl.
plan_idpathstring

Cuerpo obligatorio PlanUpdate

CampoTipoObl.
namestring o nuloNo
monthly_price_centsinteger o nuloNo
annual_price_centsinteger o nuloNo
module_keyslista de string o nuloNo
max_branchesinteger o nuloNo
max_usersinteger o nuloNo
max_doctorsinteger o nuloNo
max_patientsinteger o nuloNo
is_activeboolean o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaPlanOut
422Error de validaciónHTTPValidationError
DELETE/v1/admin/plans/{plan_id}

Delete Plan

Parámetros

NombreEnTipoObl.
plan_idpathstring

Respuestas

CódigoDescripciónDevuelve
204Respuesta correcta
422Error de validaciónHTTPValidationError
POST/v1/admin/tenants/{tenant_id}/branches

Create Tenant Branch

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio app__schemas__subscription__BranchCreateIn

CampoTipoObl.
namestring
codestring
citystringNo
addressstringNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaapp__schemas__subscription__BranchOut
422Error de validaciónHTTPValidationError
POST/v1/admin/tenants/{tenant_id}/doctors

Create Tenant Doctor

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio app__schemas__subscription__DoctorCreateIn

CampoTipoObl.
codestring
full_namestring
specialtystring
branch_idstring o nuloNo
emailstring o nuloNo
phonestring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaapp__schemas__subscription__DoctorOut
422Error de validaciónHTTPValidationError
PUT/v1/admin/tenants/{tenant_id}/modules/{module_key}

Toggle Tenant Module

Parámetros

NombreEnTipoObl.
tenant_idpathstring
module_keypathstring

Cuerpo obligatorio TenantModuleToggleIn

CampoTipoObl.
enabledboolean

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaTenantModuleOut
422Error de validaciónHTTPValidationError
POST/v1/admin/tenants/{tenant_id}/patients

Create Tenant Patient

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio app__schemas__subscription__PatientCreateIn

CampoTipoObl.
medical_record_nostring
first_namestring
last_namestring
branch_idstring o nuloNo
document_idstring o nuloNo
emailstring o nuloNo
phonestring o nuloNo
birth_datestring (date-time) o nuloNo
genderstring o nuloNo
racestring o nuloNo
ethnicitystring o nuloNo
marital_statusstring o nuloNo
occupationstring o nuloNo
preferred_languagestring o nuloNo
height_cmnumber o nuloNo
weightLbnumber o nuloNo
provincestring o nuloNo
municipalitystring o nuloNo
street_addressstring o nuloNo
primary_doctor_idstring o nuloNo
emergency_contactstring o nuloNo
emergency_contact_namestring o nuloNo
emergency_contact_relationshipstring o nuloNo
emergency_contact_phonestring o nuloNo
emergency_contact_emailstring o nuloNo
preferred_pharmacystring o nuloNo
conditionNameslista de stringNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaapp__schemas__subscription__PatientOut
422Error de validaciónHTTPValidationError
GET/v1/admin/tenants/{tenant_id}/subscription

Get Subscription

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaTenantSubscriptionInfoOut o nulo
422Error de validaciónHTTPValidationError
PUT/v1/admin/tenants/{tenant_id}/subscription

Assign Subscription

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio TenantSubscriptionAssignIn

CampoTipoObl.
plan_codestring o nuloNo
plan_idstring o nuloNo
statusstringNo
expires_atstring (date-time) o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaTenantSubscriptionOut
422Error de validaciónHTTPValidationError
POST/v1/admin/tenants/{tenant_id}/users

Create Tenant User

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio app__schemas__subscription__UserCreateIn

CampoTipoObl.
full_namestring
emailstring
passwordstring
rolestringNo
branch_idstring o nuloNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaapp__schemas__subscription__UserOut
422Error de validaciónHTTPValidationError