Recurso

Planes de la institución

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

GET/v1/insurance-plans

List Insurance Plans

Parámetros

NombreEnTipoObl.
pagequeryintegerNo
page_sizequeryintegerNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaPagedResponse_InsurancePlanOut_
422Error de validaciónHTTPValidationError
POST/v1/insurance-plans

Create Insurance Plan

Cuerpo obligatorio InsurancePlanCreateIn

CampoTipoObl.
codestring
namestring
provider_namestring
is_activebooleanNo

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaInsurancePlanOut
422Error de validaciónHTTPValidationError
GET/v1/plans

List Managed Plans

Parámetros

NombreEnTipoObl.
pagequeryintegerNo
page_sizequeryintegerNo

Respuestas

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

Create Managed 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/plans/{plan_id}

Update Managed 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
GET/v1/tenants

List Managed Tenants

Parámetros

NombreEnTipoObl.
pagequeryintegerNo
page_sizequeryintegerNo
searchquerystring o nuloNo
statusquerystring o nuloNo
clientTypequerystring o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaTenantListOut
422Error de validaciónHTTPValidationError
POST/v1/tenants

Create Managed Tenant

Cuerpo obligatorio TenantCreateIn

CampoTipoObl.
slugstring
namestring
commercial_namestring
emailstring (email)
phonestring
client_typestring
is_activebooleanNo

Respuestas

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

Get Managed Tenant

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaTenantDetailOut
422Error de validaciónHTTPValidationError
PATCH/v1/tenants/{tenant_id}

Update Managed Tenant

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio TenantUpdateIn

CampoTipoObl.
slugstring o nuloNo
namestring o nuloNo
commercial_namestring o nuloNo
emailstring (email) o nuloNo
phonestring o nuloNo
client_typestring o nuloNo
descriptionstring o nuloNo
citystring o nuloNo
websitestring o nuloNo
logo_urlstring o nuloNo
services_offeredlista de string o nuloNo
is_activeboolean o nuloNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaTenantOut
422Error de validaciónHTTPValidationError
GET/v1/tenants/{tenant_id}/modules

List Managed Tenant Modules

Parámetros

NombreEnTipoObl.
tenant_idpathstring
pagequeryintegerNo
page_sizequeryintegerNo

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaPagedResponse_TenantModuleListOut_
422Error de validaciónHTTPValidationError
PATCH/v1/tenants/{tenant_id}/modules

Bulk Update Managed Tenant Modules

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Cuerpo obligatorio TenantModuleBulkUpdateIn

CampoTipoObl.
moduleslista de TenantModuleBulkItemIn

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de TenantModuleListOut
422Error de validaciónHTTPValidationError
GET/v1/tenants/{tenant_id}/subscription

Get Managed Subscription

Parámetros

NombreEnTipoObl.
tenant_idpathstring

Respuestas

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

Assign Managed 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