Usuarios y sucursales — BestDoctorsRD API

GET/v1/branches

List Branches

Parámetros

Nombre	En	Tipo	Obl.
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de app__api__routes__users_branches__BranchOut
422	Error de validación	HTTPValidationError

POST/v1/branches

Create Branch

Cuerpo obligatorio `appapiroutes__users_branches__BranchCreateIn`

Campo	Tipo	Obl.
`name`	string	Sí
`code`	string	Sí
`city`	string	No
`province`	string	No
`phone`	string	No
`address`	string	No
`email`	string	No
`tenant_id`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	app__api__routes__users_branches__BranchOut
422	Error de validación	HTTPValidationError

GET/v1/branches/options

List Branch Options

Las sucursales activas de MI institución, para poder elegir una. Existe porque las diez pantallas del portal con desplegable de sucursal llamaban a `GET /v1/branches`, que no es un selector sino el listado de administración: guardado con `_USER_MANAGEMENT_ROLES` y con las cifras de plantilla dentro. RECEPTION y NURSE recibían 403, el portal se lo tragaba con `.catch(() => [])` y el combo salía vacío en todas partes, sin error a la vista. Medido en producción. Va declarada ANTES que `/branches/{branch_id}`: al revés, «options» entraría por el parámetro de ruta —que es un entero— y esto respondería 422 en lugar de la lista.

Parámetros

Nombre	En	Tipo	Obl.
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de app__api__routes__users_branches__BranchOptionOut
422	Error de validación	HTTPValidationError

PATCH/v1/branches/{branch_id}

Update Branch

Parámetros

Nombre	En	Tipo	Obl.
`branch_id`	path	integer	Sí

Cuerpo obligatorio `BranchUpdateIn`

Campo	Tipo	Obl.
`name`	string o nulo	No
`code`	string o nulo	No
`city`	string o nulo	No
`province`	string o nulo	No
`phone`	string o nulo	No
`address`	string o nulo	No
`email`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__users_branches__BranchOut
422	Error de validación	HTTPValidationError

DELETE/v1/branches/{branch_id}

Delete Branch

Parámetros

Nombre	En	Tipo	Obl.
`branch_id`	path	integer	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

PATCH/v1/branches/{branch_id}/deactivate

Deactivate Branch

Parámetros

Nombre	En	Tipo	Obl.
`branch_id`	path	integer	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__users_branches__BranchOut
422	Error de validación	HTTPValidationError

GET/v1/users

List Users

Parámetros

Nombre	En	Tipo	Obl.
`tenant_id`	query	string o nulo	No
`role`	query	string o nulo	No
`branch_id`	query	string o nulo	No
`is_active`	query	boolean o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	lista de app__api__routes__users_branches__UserOut
422	Error de validación	HTTPValidationError

POST/v1/users

Create User

Cuerpo obligatorio `appapiroutes__users_branches__UserCreateIn`

Campo	Tipo	Obl.
`full_name`	string	Sí
`email`	string	Sí
`phone`	string o nulo	No
`password`	string o nulo	No
`role`	string	No
`roles`	lista de string o nulo	No
`branch_id`	string o nulo	No
`tenant_id`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	app__api__routes__users_branches__UserOut
422	Error de validación	HTTPValidationError

PATCH/v1/users/me/password

Change Own Password

Cuerpo obligatorio `PasswordChangeIn`

Campo	Tipo	Obl.
`currentPassword`	string	Sí
`newPassword`	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__users_branches__UserOut
422	Error de validación	HTTPValidationError

GET/v1/users/{user_id}

Get User

Parámetros

Nombre	En	Tipo	Obl.
`user_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__users_branches__UserOut
422	Error de validación	HTTPValidationError

PATCH/v1/users/{user_id}

Update User

Parámetros

Nombre	En	Tipo	Obl.
`user_id`	path	string	Sí

Cuerpo obligatorio `UserUpdateIn`

Campo	Tipo	Obl.
`full_name`	string o nulo	No
`email`	string o nulo	No
`phone`	string o nulo	No
`role`	string o nulo	No
`roles`	lista de string o nulo	No
`branch_id`	string o nulo	No
`is_active`	boolean o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__users_branches__UserOut
422	Error de validación	HTTPValidationError

DELETE/v1/users/{user_id}

Delete User

Parámetros

Nombre	En	Tipo	Obl.
`user_id`	path	string	Sí

Respuestas

Código	Descripción	Devuelve
204	Respuesta correcta	—
422	Error de validación	HTTPValidationError

PATCH/v1/users/{user_id}/password

Reset User Password

Parámetros

Nombre	En	Tipo	Obl.
`user_id`	path	string	Sí

Cuerpo obligatorio `UserPasswordResetIn`

Campo	Tipo	Obl.
`password`	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	app__api__routes__users_branches__UserOut
422	Error de validación	HTTPValidationError

List Branches

Parámetros

Respuestas

Create Branch

Cuerpo obligatorio app__api__routes__users_branches__BranchCreateIn

Respuestas

List Branch Options

Parámetros

Respuestas

Update Branch

Parámetros

Cuerpo obligatorio BranchUpdateIn

Respuestas

Delete Branch

Parámetros

Respuestas

Deactivate Branch

Parámetros

Respuestas

List Users

Parámetros

Respuestas

Create User

Cuerpo obligatorio app__api__routes__users_branches__UserCreateIn

Respuestas

Change Own Password

Cuerpo obligatorio PasswordChangeIn

Respuestas

Get User

Parámetros

Respuestas

Update User

Parámetros

Cuerpo obligatorio UserUpdateIn

Respuestas

Delete User

Parámetros

Respuestas

Reset User Password

Parámetros

Cuerpo obligatorio UserPasswordResetIn

Respuestas

Cuerpo obligatorio `appapiroutes__users_branches__BranchCreateIn`

Cuerpo obligatorio `BranchUpdateIn`

Cuerpo obligatorio `appapiroutes__users_branches__UserCreateIn`

Cuerpo obligatorio `PasswordChangeIn`

Cuerpo obligatorio `UserUpdateIn`

Cuerpo obligatorio `UserPasswordResetIn`