Instituciones

Instituciones, política de privacidad y términos de uso de cada una.

Lista las instituciones que la persona ve

GET /instituicoes

Acceso: Exige la capacidad LER, en algún ámbito (la respuesta trae solo lo que la persona puede ver). Estado de éxito: 200.

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`busca`	`string`	no	a 100 caracteres	Texto para buscar (nombre o correo, según la ruta).
`limite`	`integer`	no	1…200; por defecto: `50`	Cuántos elementos por página (1 a 200; el valor predeterminado varía por ruta, en general 50).
`deslocamento`	`integer`	no	0…100000; por defecto: `0`	Cuántos elementos saltar, para paginar (hasta 100000).
`inativos`	`"true"` \| `"false"`	no	por defecto: `"false"`	`true` incluye también los registros inactivos.

Respuesta

lista de InstituicaoDto (+ total)

Campo	Tipo	Obligatorio	Descripción
`id`	`string (uuid)`	sí
`sigla`	`string`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`locale`	`"pt-BR"` \| `"es"` \| `"en-US"` o `nulo`	sí
`timezone`	`string`	sí
`retencaoMeses`	`integer` o `nulo`	sí
`controladorNome`	`string` o `nulo`	no	Datos de privacidad de la institución; la API siempre los envía (nulos cuando no se informaron).
`encarregadoNome`	`string` o `nulo`	no
`contatoPrivacidade`	`string` o `nulo`	no

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/instituicoes" -H "Authorization: Bearer $TOKEN"

Crea una institución e invita al primer curador

POST /instituicoes

Acceso: Exige la capacidad PLATAFORMA. Estado de éxito: 201.

Cuerpo de la solicitud (InstituicaoCriar)

Campo	Tipo	Obligatorio	Restricciones	Descripción
`sigla`	`string`	sí	`^[A-Za-z0-9][A-Za-z0-9._-]{1,19}$`
`nome`	`string`	sí	1–200 caracteres
`locale`	`"pt-BR"` \| `"es"` \| `"en-US"` o `nulo`	no
`timezone`	Fuso	no
`retencaoMeses`	`integer` o `nulo`	no	1…600
`curador`	`object`	no		Primer curador de la institución: recibe la invitación por correo.
`curador.email`	Email	sí
`curador.nome`	`string`	sí	1–200 caracteres

Respuesta

InstituicaoDto

Campo	Tipo	Obligatorio	Descripción
`id`	`string (uuid)`	sí
`sigla`	`string`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`locale`	`"pt-BR"` \| `"es"` \| `"en-US"` o `nulo`	sí
`timezone`	`string`	sí
`retencaoMeses`	`integer` o `nulo`	sí
`controladorNome`	`string` o `nulo`	no	Datos de privacidad de la institución; la API siempre los envía (nulos cuando no se informaron).
`encarregadoNome`	`string` o `nulo`	no
`contatoPrivacidade`	`string` o `nulo`	no

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X POST "$API/instituicoes" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"sigla":"texto","nome":"texto"}'

Lee una institución

GET /instituicoes/{instituicaoId}

Acceso: Exige la capacidad LER sobre institución (params.instituicaoId). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`instituicaoId`	`string (uuid)`	sí		Id de la institución.

Respuesta

InstituicaoDto

Campo	Tipo	Obligatorio	Descripción
`id`	`string (uuid)`	sí
`sigla`	`string`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`locale`	`"pt-BR"` \| `"es"` \| `"en-US"` o `nulo`	sí
`timezone`	`string`	sí
`retencaoMeses`	`integer` o `nulo`	sí
`controladorNome`	`string` o `nulo`	no	Datos de privacidad de la institución; la API siempre los envía (nulos cuando no se informaron).
`encarregadoNome`	`string` o `nulo`	no
`contatoPrivacidade`	`string` o `nulo`	no

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/instituicoes/{instituicaoId}" -H "Authorization: Bearer $TOKEN"

Actualiza una institución

PATCH /instituicoes/{instituicaoId}

Acceso: Exige la capacidad ADMINISTRAR sobre institución (params.instituicaoId). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`instituicaoId`	`string (uuid)`	sí		Id de la institución.

Cuerpo de la solicitud (InstituicaoAtualizar)

Campo	Tipo	Obligatorio	Restricciones	Descripción
`nome`	`string`	no	1–200 caracteres
`locale`	`"pt-BR"` \| `"es"` \| `"en-US"` o `nulo`	no
`timezone`	Fuso	no
`retencaoMeses`	`integer` o `nulo`	no	1…600
`controladorNome`	`string` o `nulo`	no	1–200 caracteres	Privacidad (LGPD): `null` borra el valor y vuelve al predeterminado de la plataforma.
`encarregadoNome`	`string` o `nulo`	no	1–200 caracteres
`contatoPrivacidade`	Email o `nulo`	no
`ativo`	`boolean`	no

Respuesta

InstituicaoDto

Campo	Tipo	Obligatorio	Descripción
`id`	`string (uuid)`	sí
`sigla`	`string`	sí
`nome`	`string`	sí
`ativo`	`boolean`	sí
`locale`	`"pt-BR"` \| `"es"` \| `"en-US"` o `nulo`	sí
`timezone`	`string`	sí
`retencaoMeses`	`integer` o `nulo`	sí
`controladorNome`	`string` o `nulo`	no	Datos de privacidad de la institución; la API siempre los envía (nulos cuando no se informaron).
`encarregadoNome`	`string` o `nulo`	no
`contatoPrivacidade`	`string` o `nulo`	no

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X PATCH "$API/instituicoes/{instituicaoId}" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'

Lee la política de privacidad vigente de la institución

GET /instituicoes/{instituicaoId}/politica-privacidade

Acceso: Exige la capacidad LER sobre institución (params.instituicaoId). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`instituicaoId`	`string (uuid)`	sí		Id de la institución.

Respuesta

PoliticaDto

Campo	Tipo	Obligatorio
`versao`	`integer` o `nulo`	sí
`textos`	TermoTextos	sí
`publicadoEm`	`string (date-time)` o `nulo`	sí
`urlPublica`	`string`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/instituicoes/{instituicaoId}/politica-privacidade" -H "Authorization: Bearer $TOKEN"

Publica una nueva versión de la política de privacidad

PUT /instituicoes/{instituicaoId}/politica-privacidade

Acceso: Exige la capacidad ADMINISTRAR sobre institución (params.instituicaoId). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`instituicaoId`	`string (uuid)`	sí		Id de la institución.

Cuerpo de la solicitud (TermoPublicar)

Campo	Tipo	Obligatorio	Restricciones	Descripción
`textos`	TermoTextos	sí

Respuesta

PoliticaDto

Campo	Tipo	Obligatorio
`versao`	`integer` o `nulo`	sí
`textos`	TermoTextos	sí
`publicadoEm`	`string (date-time)` o `nulo`	sí
`urlPublica`	`string`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X PUT "$API/instituicoes/{instituicaoId}/politica-privacidade" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"textos":{}}'

Lee los términos de uso vigentes de la institución

GET /instituicoes/{instituicaoId}/termo

Acceso: Exige la capacidad LER sobre institución (params.instituicaoId). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`instituicaoId`	`string (uuid)`	sí		Id de la institución.

Respuesta

TermoDto

Campo	Tipo	Obligatorio
`versao`	`integer` o `nulo`	sí
`textos`	TermoTextos	sí
`publicadoEm`	`string (date-time)` o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X GET "$API/instituicoes/{instituicaoId}/termo" -H "Authorization: Bearer $TOKEN"

Publica una nueva versión de los términos de uso

PUT /instituicoes/{instituicaoId}/termo

Acceso: Exige la capacidad ADMINISTRAR sobre institución (params.instituicaoId). Estado de éxito: 200.

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Restricciones	Descripción
`instituicaoId`	`string (uuid)`	sí		Id de la institución.

Cuerpo de la solicitud (TermoPublicar)

Campo	Tipo	Obligatorio	Restricciones	Descripción
`textos`	TermoTextos	sí

Respuesta

TermoDto

Campo	Tipo	Obligatorio
`versao`	`integer` o `nulo`	sí
`textos`	TermoTextos	sí
`publicadoEm`	`string (date-time)` o `nulo`	sí

En caso de error: modelo ErroApi.

Ejemplo

bash

curl -X PUT "$API/instituicoes/{instituicaoId}/termo" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"textos":{}}'

Instituciones ​

Lista las instituciones que la persona ve ​

Crea una institución e invita al primer curador ​

Lee una institución ​

Actualiza una institución ​

Lee la política de privacidad vigente de la institución ​

Publica una nueva versión de la política de privacidad ​

Lee los términos de uso vigentes de la institución ​

Publica una nueva versión de los términos de uso ​

Instituciones

Lista las instituciones que la persona ve

Crea una institución e invita al primer curador

Lee una institución

Actualiza una institución

Lee la política de privacidad vigente de la institución

Publica una nueva versión de la política de privacidad

Lee los términos de uso vigentes de la institución

Publica una nueva versión de los términos de uso