List Institutions
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
page | query | string o nulo | No |
page_size | query | string o nulo | No |
q | query | string o nulo | No |
category | query | string o nulo | No |
type | query | string o nulo | No |
status | query | string o nulo | No |
sort_by | query | string | No |
sort_dir | query | string | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | PagedResponse_InstitutionOut_ |
| 422 | Error de validación | HTTPValidationError |
Create Institution
Cuerpo obligatorio InstitutionCreateIn
| Campo | Tipo | Obl. |
|---|
name | string | Sí |
commercial_name | string o nulo | No |
institution_category | InstitutionCategory | Sí |
rnc | string o nulo | No |
email | string (email) o nulo | No |
phone | string o nulo | No |
address | string o nulo | No |
is_active | boolean | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | InstitutionOut |
| 422 | Error de validación | HTTPValidationError |
/v1/institutions/{institution_id}Get Institution
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
institution_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | InstitutionOut |
| 422 | Error de validación | HTTPValidationError |
/v1/institutions/{institution_id}Update Institution
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
institution_id | path | string | Sí |
Cuerpo obligatorio InstitutionUpdateIn
| Campo | Tipo | Obl. |
|---|
name | string o nulo | No |
commercial_name | string o nulo | No |
institution_category | InstitutionCategory o nulo | No |
rnc | string o nulo | No |
email | string (email) o nulo | No |
phone | string o nulo | No |
address | string o nulo | No |
is_active | boolean o nulo | No |
province | string o nulo | No |
municipality | string o nulo | No |
neighborhood | string o nulo | No |
registration_plan | string o nulo | No |
registration_modules | lista de string o nulo | No |
wants_landing_page | boolean o nulo | No |
treatment_area_code | string o nulo | No |
treatment_services | lista de string o nulo | No |
treatment_note | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | InstitutionOut |
| 422 | Error de validación | HTTPValidationError |
/v1/institutions/{institution_id}Delete Institution
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
institution_id | path | string | Sí |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 204 | Respuesta correcta | — |
| 422 | Error de validación | HTTPValidationError |