Skip to content

GitLab

requisitos api · Changes

Page history
Update requisitos api authored by Eduardo Arruda's avatar Eduardo Arruda
Hide whitespace changes
Inline Side-by-side
requisitos-api.md
View page @ 089807bc
...@@ -4,216 +4,218 @@ ...@@ -4,216 +4,218 @@
### Resource: **oauth** ### Resource: **oauth**
**RFS01:** POST /oauth **RFS01:** POST /oauth
### Resource: **usuario** ### Resource: **usuario**
**RFU01:** POST /usuarios **RFU01:** POST /usuarios
**RFU02:** GET /usuarios **RFU02:** GET /usuarios
**RFU03:** GET /usuarios/{id_usuario} **RFU03:** GET /usuarios/{id_usuario}
**RFU04:** PUT /usuarios/{id_usuario} **RFU04:** PUT /usuarios/{id_usuario}
**RFU05:** DELETE /usuarios/{id_usuario} **RFU05:** DELETE /usuarios/{id_usuario}
**RFU06:** GET /usuarios/{id_usuario}/perfis
**RFU09:** PUT /usuarios/{id_usuario}/perfis
### Resource: **menor** ### Resource: **menor**
**RFM01:** POST /menores **RFM01:** POST /menores
**RFM02:** GET /menores **RFM02:** GET /menores
**RFM03:** GET /menores/{id_menor} **RFM03:** GET /menores/{id_menor}
**RFM04:** PUT /menores/{id_menor} **RFM04:** PUT /menores/{id_menor}
**RFM05:** DELETE /menores/{id_menor} **RFM05:** DELETE /menores/{id_menor}
**RFM06:** GET /menores/ordenacao **RFM06:** GET /menores?ordenacao={idade=-1~+1, sexo=-1~+1}
**RFM07:** POST /menores/{id_menor}/interessados **RFM07:** POST /menores/{id_menor}/interessados
**RFM08:** GET /menores/{id_menor}/interessados **RFM08:** GET /menores/{id_menor}/interessados
**RFM09:** DELETE /menores/{id_menor}/interessados/{id_interessado} **RFM09:** DELETE /menores/{id_menor}/interessados/{id_interessado}
**RFM10:** POST /menores/{id_menor}/imagens **RFM10:** POST /menores/{id_menor}/imagens
**RFM11:** GET /menores/{id_menor}/imagens **RFM11:** GET /menores/{id_menor}/imagens
**RFM12:** GET /menores/{id_menor}/imagens/{id_imagem} **RFM12:** GET /menores/{id_menor}/imagens/{id_imagem}
**RFM13:** DELETE /menores/{id_menor}/imagens/{id_imagem} **RFM13:** DELETE /menores/{id_menor}/imagens/{id_imagem}
**RFM14:** POST /menores/{id_menor}/videos **RFM14:** POST /menores/{id_menor}/videos
**RFM15:** GET /menores/{id_menor}/videos **RFM15:** GET /menores/{id_menor}/videos
**RFM16:** GET /menores/{id_menor}/videos/{id_video} **RFM16:** GET /menores/{id_menor}/videos/{id_video}
**RFM17:** DELETE /menores/{id_menor}/videos/{id_video} **RFM17:** DELETE /menores/{id_menor}/videos/{id_video}
### Resource: **interessado** ### Resource: **interessado**
**RFI01:** POST /interessados **RFI01:** POST /interessados
**RFI02:** GET /interessados **RFI02:** GET /interessados
**RFI03:** GET /interessados/{id_interessado} **RFI03:** GET /interessados/{id_interessado}
**RFI04:** PUT /interessados/{id_interessado} **RFI04:** PUT /interessados/{id_interessado}
**RFI05:** DELETE /interessados/{id_interessado} **RFI05:** DELETE /interessados/{id_interessado}
**RFI06:** PUT /interessados/{id_interessado} (id_usuario) **DEPRECATED** **RFI06:** PUT /interessados/{id_interessado} (id_usuario) **DEPRECATED**
**RFI07:** GET /interessados/{id_interessado}/ordenacao **RFI07:** GET /interessados/{id_interessado}/ordenacao
**RFI08:** PUT /interessados/{id_interessado}/ordenacao **RFI08:** PUT /interessados/{id_interessado}/ordenacao
**RFI09:** POST /interessados/{id_interessado}/visualizacoes **RFI09:** POST /interessados/{id_interessado}/visualizacoes
**RFI10:** GET /interessados/{id_interessado}/visualizacoes **RFI10:** GET /interessados/{id_interessado}/visualizacoes
**RFI11:** PUT /interessados/{id_interessado}/visualizacoes **RFI11:** PUT /interessados/{id_interessado}/visualizacoes
**RFI12:** GET /interessados?query=id_menor={id_menor} **RFI12:** GET /interessados?query=id_menor={id_menor}
**RFI13:** POST /interessados/{id_interessado}/menores **RFI13:** POST /interessados/{id_interessado}/menores
**RFI14:** GET /interessados/{id_interessado}/menores **RFI14:** GET /interessados/{id_interessado}/menores
**RFI15:** DELETE /interessados/{id_interessado}/menores/{id_menor} **RFI15:** DELETE /interessados/{id_interessado}/menores/{id_menor}
### Resource: **conteudo** ### Resource: **conteudo**
**RFC01:** POST /conteudos **RFC01:** POST /conteudos
**RFC02:** GET /conteudos **RFC02:** GET /conteudos
**RFC03:** PUT /conteudos/{id_conteudo} **RFC03:** PUT /conteudos/{id_conteudo}
**RFC04:** DELETE /conteudos/{id_conteudo} **RFC04:** DELETE /conteudos/{id_conteudo}
**RFC05:** POST /conteudos/{id_conteudo}/imagens **RFC05:** POST /conteudos/{id_conteudo}/imagens
**RFC06:** GET /conteudos/{id_conteudo}/imagens **RFC06:** GET /conteudos/{id_conteudo}/imagens
**RFC07:** GET /conteudos/{id_conteudo}/imagens/{id_imagem} **RFC07:** GET /conteudos/{id_conteudo}/imagens/{id_imagem}
**RFC08:** DELETE /conteudos/{id_conteudo}/imagens/{id_imagem} **RFC08:** DELETE /conteudos/{id_conteudo}/imagens/{id_imagem}
**RFC09:** POST /conteudos/{id_conteudo}/videos **RFC09:** POST /conteudos/{id_conteudo}/videos
**RFC10:** GET /conteudos/{id_conteudo}/videos **RFC10:** GET /conteudos/{id_conteudo}/videos
**RFC11:** GET /conteudos/{id_conteudo}/videos/{id_video} **RFC11:** GET /conteudos/{id_conteudo}/videos/{id_video}
**RFC12:** DELETE /conteudos/{id_conteudo}/videos/{id_video} **RFC12:** DELETE /conteudos/{id_conteudo}/videos/{id_video}
## Semestre 2017-2 ## Semestre 2017-2
### Resource: **usuario** ### Resource: **usuario**
**RFU06:** GET /usuarios/{id_usuario}/perfis **RFU07:** POST /usuarios/{id_usuario}/perfis
**RFU07:** POST /usuarios/{id_usuario}/perfis
**RFU08:** DELETE /usuarios/{id_usuario}/perfis/{id_perfil} **RFU08:** DELETE /usuarios/{id_usuario}/perfis/{id_perfil}
### Resource: **perfil** ### Resource: **perfil**
**RFP01:** POST /perfis **RFP01:** POST /perfis
**RFP02:** GET /perfis **RFP02:** GET /perfis
**RFP03:** GET /perfis/{id_perfil} **RFP03:** GET /perfis/{id_perfil}
**RFP04:** PUT /perfis/{id_perfil} **RFP04:** PUT /perfis/{id_perfil}
**RFP05:** DELETE /perfis/{id_perfil} **RFP05:** DELETE /perfis/{id_perfil}
**RFP06:** GET /perfis/{id_perfil}/usuarios **RFP06:** GET /perfis/{id_perfil}/usuarios
**RFP07:** POST /perfis/{id_perfil}/usuarios **RFP07:** POST /perfis/{id_perfil}/usuarios
**RFP08:** DELETE /perfis/{id_perfil}/usuarios/{id_usuario} **RFP08:** DELETE /perfis/{id_perfil}/usuarios/{id_usuario}
### Resource: **menor** ### Resource: **menor**
**RFM18:** PUT /menores/{id_menor} (id_abrigo ou id_familia) **RFM18:** PUT /menores/{id_menor} (id_abrigo ou id_familia)
**RFM09:** POST /menores/{id_menor}/processos **RFM09:** POST /menores/{id_menor}/processos
**RFM20:** GET /menores/{id_menor}/processos **RFM20:** GET /menores/{id_menor}/processos
**RFM21:** GET /menores/{id_menor}/processos/{id_processo} **RFM21:** GET /menores/{id_menor}/processos/{id_processo}
**RFM22:** DELETE /menores/{id_menor}/processos/{id_processo} **RFM22:** DELETE /menores/{id_menor}/processos/{id_processo}
### Resource: **interessado** ### Resource: **interessado**
**RFI16:** POST /interessados/{id_interessado}/menores/{id_menor}/compartilhamentos **RFI16:** POST /interessados/{id_interessado}/menores/{id_menor}/compartilhamentos
**RFI17:** GET /interessados/{id_interessado}/mensagens **RFI17:** GET /interessados/{id_interessado}/mensagens
**RFI18:** PUT /usuarios/{id_usuario}/mensagens **RFI18:** PUT /usuarios/{id_usuario}/mensagens
**RFI19:** POST /interessados/{id_interessado}/documentos **RFI19:** POST /interessados/{id_interessado}/documentos
**RFI20:** GET /interessados/{id_interessado}/documentos **RFI20:** GET /interessados/{id_interessado}/documentos
**RFI21:** GET /interessados/{id_interessado}/documentos/{id_documento} **RFI21:** GET /interessados/{id_interessado}/documentos/{id_documento}
### Resource: **mensagem** ### Resource: **mensagem**
**RFM01:** POST /mensagens **RFM01:** POST /mensagens
**RFM02:** GET /mensagens **RFM02:** GET /mensagens
**RFM03:** GET /mensagens?query=data_inicial={data_inicial}&data_final={data_final} **RFM03:** GET /mensagens?query=data_inicial={data_inicial}&data_final={data_final}
**RFM04:** PUT /mensagens/{id_mensagem} **RFM04:** PUT /mensagens/{id_mensagem}
**RFM05:** POST /mensagens/{id_mensagem}/resposta **RFM05:** POST /mensagens/{id_mensagem}/resposta
**RFM06:** DELETE /mensagens/{id_mensagem} **RFM06:** DELETE /mensagens/{id_mensagem}
### Resource: **abrigo** ### Resource: **abrigo**
**RFA01:** POST /abrigos **RFA01:** POST /abrigos
**RFA02:** GET /abrigos **RFA02:** GET /abrigos
**RFA03:** PUT /abrigos/{id_abrigo} **RFA03:** PUT /abrigos/{id_abrigo}
**RFA04:** DELETE /abrigos/{id_abrigo} **RFA04:** DELETE /abrigos/{id_abrigo}
### Resource: **familia** ### Resource: **familia**
**RFF01:** POST /familias **RFF01:** POST /familias
**RFF02:** GET /familias **RFF02:** GET /familias
**RFF03:** PUT /familias/{id_familia} **RFF03:** PUT /familias/{id_familia}
**RFF04:** DELETE /familias/{id_familia} **RFF04:** DELETE /familias/{id_familia}
### Resource: **processo** ### Resource: **processo**
**RFO01:** POST /processos **RFO01:** POST /processos
**RFO02:** GET /processos **RFO02:** GET /processos
**RFO03:** PUT /processos/{id_processo} **RFO03:** PUT /processos/{id_processo}
**RFO04:** DELETE /processos/{id_processo} **RFO04:** DELETE /processos/{id_processo}
**RFO05:** POST /processos/{id_processo}/movimentos **RFO05:** POST /processos/{id_processo}/movimentos
**RFO06:** GET /processos/{id_processo}/movimentos **RFO06:** GET /processos/{id_processo}/movimentos
**RFO07:** PUT /processos/{id_processo}/movimentos/{id_movimento} **RFO07:** PUT /processos/{id_processo}/movimentos/{id_movimento}
**RFO08:** DELETE /processos/{id_processo}/movimentos/{id_movimento} **RFO08:** DELETE /processos/{id_processo}/movimentos/{id_movimento}