Skip to content

BPerdona/api-donators

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sistema de registro de doadores, doações e organizações parceiras via api rest.

Desenvolvido em um projeto de extensão e atualmente está sendo utilizado pela instituição que foi beneficiada.

Rotas:

  • <Domínio>/v1/admin (GET)
    É necessario informar username e password, se for validado e houver um admin com esses parametros sera retornado um token de acesso para as outras rotas, se não houver retornara status(401);

DONATOR

  • <Domínio>/v1/donator (GET)
    Retorna todos os membros doadores cadastrados.

  • <Domínio>/v1/donator (POST)
    Deve ser utilizada para criar um doador, deve seguir todos atributos via JSON, retorna o doador criado.

  • <Domínio>/v1/donator/:RG (GET)
    Retorna o doador que possui o rg informado, caso não haja retornara um erro.

  • <Domínio>/v1/donator/:RG (DELETE)
    Retorna o doador excluido, caso não haja ninguem com esse rg, retornara um erro. Esta sendo utilizado o sistemas de status(O cadastro em si não é excluido, seu status apenas muda para desativado), necessario confirmar regra de negocio.

  • <Domínio>/v1/donator/:RG (PUT)
    Deve ser usado para atualizar o cadastro de um doador, devera seguir todos os atributos em formato JSON e ter um rg valido, retorna o doador com os dados atualizados.

DONATIONS

  • <Domínio>/v1/donation (GET)
    Retorna todos as doações cadastrados.

  • <Domínio>/v1/donation (POST)
    Deve ser utilizada para criar uma doação, deve seguir todos atributos via JSON, retorna o doador criado.

  • <Domínio>/v1/donation/:ID (GET)
    Retorna a doação que possui o id informado, caso não haja retornara um erro.

  • <Domínio>/v1/donation/:ID (DELETE)
    Retorna a doação excluida, caso não haja nenhuma com esse id, retornara um erro.

  • <Domínio>/v1/donation/:ID (PUT)
    Deve ser usado para atualizar uma doação, devera seguir todos os atributos em formato JSON e ter um id valido, retorna a doação com os dados atualizados.

PARTNERS

  • <Domínio>/v1/collector (GET)
    Retorna todos as organizações coletoras cadastradas.

  • <Domínio>/v1/collector (POST)
    Deve ser utilizada para criar uma organização coletora, deve seguir todos atributos via JSON, retorna a organização criada.

  • <Domínio>/v1/collector/:ID (GET)
    Retorna a organização coletora que possui o id informado, caso não haja retornara um erro.

  • <Domínio>/v1/collector/:ID (DELETE)
    Retorna organização coletora excluida, caso não haja nenhuma com esse id, retornara um erro.

  • <Domínio>/v1/collector/:ID (PUT)
    Deve ser usado para atualizar uma organização coletora devera seguir todos os atributos em formato JSON e ter um id valido, retorna a organização coletorac om os dados atualizados.

CEP

  • <Domínio>/v1/cep/:CEP (GET)
    Se nada der errado é para retornar informações sobre o cep.

PROFESSION

  • <Domínio>/v1/profissao (GET)
    Deve retornar as profissoes cadastradas.

  • <Domínio>/v1/profissao (POST)
    Utilizada para criar uma profissao via api.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors