Introdução

Esta página descreve os endpoints relacionados à aplicação. Abaixo, você encontrará os detalhes de cada endpoint, incluindo a URI, método HTTP, parâmetros e respostas.

ArticleController

Obter Artigo Específico

• URI: /articles/{articleId}
• Método: GET
• Parâmetros:
  • articleId ID do artigo.
  • language Idioma solicitado.
• Resposta:
  • 200 OK: Quando o artigo é encontrado. Retorna os detalhes do artigo.
  • 404 NOT FOUND: Se o artigo não for encontrado.

Obter Todos os Artigos

• URI: /articles
• Método: GET
• Parâmetros:
  • language Idioma solicitado.
• Resposta:
  • 200 OK: Retorna uma lista de artigos. Se não houver artigos, retorna uma lista vazia.

Criar Artigo

• URI: /articles
• Método: POST
• Corpo da requisição: Contém os detalhes do artigo a ser criado. ID é autogerado.
• Resposta:
  • 201 CREATED: Quando o artigo é criado com sucesso. Retorna os detalhes do artigo recém-criado.

ImmigrantController

Deletar Imigrante

• URI: /immigrants/{email}
• Método: DELETE
• Parâmetros:
  • email E-mail do imigrante.
• Resposta:
  • 204 NO CONTENT: Quando o imigrante é excluído com sucesso.
  • 404 NOT FOUND: Se o imigrante não for encontrado.

Obter Todos os Imigrantes

• URI: /immigrants
• Método: GET
• Resposta:
  • 200 OK: Retorna uma lista de imigrantes. Se não houver imigrantes, retorna uma lista vazia.

Obter Imigrante Específico

• URI: /immigrants/{email}
• Método: GET
• Parâmetros:
  • email E-mail do imigrante.
• Resposta:
  • 200 OK: Quando o imigrante é encontrado. Retorna os detalhes do imigrante.
  • 404 NOT FOUND: Se o imigrante não for encontrado.

Editar Imigrante

• URI: /immigrants/{email}
• Método: PATCH
• Parâmetros:
  • email E-mail do imigrante.
• Corpo da requisição: Contém os detalhes do imigrante a ser atualizado.
• Resposta:
  • 200 OK: Retorna os detalhes do imigrante após a atualização.
  • 400 BAD REQUEST: Em caso de tentativa de alteração de e-mail ou outros erros.
  • 404 NOT FOUND: Se o imigrante não for encontrado.

Criar Imigrante

• URI: /immigrants
• Método: POST
• Corpo da requisição: Contém os detalhes do imigrante a ser criado.
• Resposta:
  • 201 CREATED: Quando o imigrante é criado com sucesso.
  • 400 BAD REQUEST: Em caso de dados inválidos.
  • 409 CONFLICT: Se o e-mail já estiver em uso.
  • 500 INTERNAL SERVER ERROR: Em caso de erro interno.

InstitutionController

Deletar Instituição

• URI: /institutions/{email}
• Método: DELETE
• Parâmetros:
  • email E-mail da instituição.
• Resposta:
  • 204 NO CONTENT: Quando a instituição é excluída com sucesso.
  • 404 NOT FOUND: Se a instituição não for encontrada.

Obter Todas as Instituições

• URI: /institutions
• Método: GET
• Parâmetros (opcional):
  • status Status da instituição.
• Resposta:
  • 200 OK: Retorna uma lista de instituições. Se não houver instituições, retorna uma lista vazia.
  • 400 BAD REQUEST: Em caso de status inválido.

Obter Instituição Específica

• URI: /institutions/{email}
• Método: GET
• Parâmetros:
  • email E-mail da instituição.
• Resposta:
  • 200 OK: Quando a instituição é encontrada. Retorna os detalhes da instituição.
  • 404 NOT FOUND: Se a instituição não for encontrada.

Editar Instituição

• URI: /institutions/{email}
• Método: PATCH
• Parâmetros:
  • email E-mail da instituição.
• Corpo da requisição: Contém os detalhes da instituição a ser atualizada.
• Resposta:
  • 200 OK: Retorna os detalhes da instituição após a atualização.
  • 400 BAD REQUEST: Em caso de dados inválidos.
  • 404 NOT FOUND: Se a instituição não for encontrada.

Atualizar Status da Instituição

• URI: /institutions/{email}/status
• Método: PATCH
• Parâmetros:
  • email E-mail da instituição.
• Cabeçalho da requisição:
  • Authorization Chave do usuário.
• Corpo da requisição:
  • status Status a ser atualizado (REJECTED/APPROVED).
  • feedback Mensagem de feedback.
• Resposta:
  • 200 OK: Retorna os detalhes da instituição após a atualização.
  • 400 BAD REQUEST: Em caso de Status inválido ou não informado.
  • 404 NOT FOUND: Se a instituição não for encontrada.

Criar Instituição

• URI: /institutions
• Método: POST
• Corpo da requisição: Contém os detalhes da instituição a ser criada.
• Resposta:
  • 201 CREATED: Quando a instituição é criada com sucesso.
  • 400 BAD REQUEST: Em caso de dados inválidos.
  • 409 CONFLICT: Se o e-mail já estiver em uso.
  • 500 INTERNAL SERVER ERROR: Em caso de erro interno.

ProgramController

Criar Programa

• URI: /programs
• Método: POST
• Corpo da requisição: Contém os detalhes do programa a ser criado.
• Resposta:
  • 201 CREATED: Quando o programa é criado com sucesso. Retorna os detalhes do programa.

Atualizar Status do Programa

• URI: /programs/{id}/status
• Método: PATCH
• Parâmetros:
  • id ID do programa.
• Cabeçalho da requisição:
  • Authorization Chave do usuário.
• Corpo da requisição:
  • status Status a ser atualizado (REJECTED/APPROVED).
  • feedback Mensagem de feedback.
• Resposta:
  • 200 OK: Retorna os detalhes do programa após a atualização.
  • 400 BAD REQUEST: Em caso de Status inválido ou não informado.
  • 404 NOT FOUND: Se o programa não for encontrado.

Obter Programa Específico

• URI: /programs/{id}
• Método: GET
• Parâmetros:
  • id ID do programa.
• Resposta:
  • 200 OK: Quando o programa é encontrado. Retorna os detalhes do programa.
  • 404 NOT FOUND: Se o programa não for encontrado.

Obter Categorias de Programas

• URI: /programs/categories
• Método: GET
• Resposta:
  • 200 OK: Retorna um mapa com as categorias e suas respectivas contagens.

Obter Todos os Programas

• URI: /programs
• Método: GET
• Parâmetros (opcional):
  • status Status do programa.
  • institutionEmail E-mail da instituição.
  • type Tipo do programa.
• Resposta:
  • 200 OK: Retorna uma lista de programas que atendem aos filtros fornecidos. Se não houver programas, retorna uma lista vazia.

Deletar Programa

• URI: /programs/{id}
• Método: DELETE
• Parâmetros:
  • id ID do programa.
• Resposta:
  • 204 NO CONTENT: Quando o programa é excluído com sucesso.
  • 404 NOT FOUND: Se o programa não for encontrado.