Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

Ambos lados da revisão anterior Revisão anterior
api_flashman [03/07/2018 04:41]
superuser
api_flashman [29/01/2019 17:21] (atual)
superuser
Linha 27: Linha 27:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                             
-| 200 | OK, retorna as informações do roteador |  +| 200         ​| OK, retorna as informações do roteador |  
-| 404 | Roteador não encontrado | +| 404         ​| Roteador não encontrado ​               
-| 500 | Erro interno do servidor |+| 500         ​| Erro interno do servidor ​              ​|
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 112: Linha 112:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                                                        ​
-| 200 | OK, retorna as informações do roteador alterado |  +| 200         ​| OK, retorna as informações do roteador alterado ​                  ​|  
-| 404 | Roteador não encontrado | +| 404         ​| Roteador não encontrado ​                                          ​
-| 500 | Erro no servidor, mais informações no body da mensagem de retorno |+| 500         ​| Erro no servidor, mais informações no body da mensagem de retorno |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 156: Linha 156:
     "​password":​ "Este campo deve ter no mínimo 8 caracteres"​     "​password":​ "Este campo deve ter no mínimo 8 caracteres"​
   ]   ]
 +}
 +</​code>​
 +
 +==== Habilitar ou desabilitar atualização de firmware de um roteador ====
 +
 +== Formato da URL ==
 +
 +<​code>​
 +/​devicelist/​update/​{MAC do roteador}/​{Release}
 +</​code>​
 +
 +== Método HTTP ==
 +
 +<​code>​
 +PUT
 +</​code>​
 +
 +== Formato da Requisição ==
 +
 +^ Parâmetro ​      ^ Descrição ​                                                          ^ Formato ​                            ^ Obrigatório ^
 +| MAC do roteador | Endereço MAC do roteador que encontra-se na etiqueta do equipamento | [A-F]:​[A-F]:​[A-F]:​[A-F]:​[A-F]:​[A-F] | Sim         |
 +| Release ​        | Identificador de release do firmware. Exemplo: 0001-fab ​            | String ​                             | Não         |
 +
 +== Parâmetros do Body ==
 +
 +^ Parâmetro ​      ^ Descrição ​                                                  ^ Formato ​ ^ Obrigatório ​ ^
 +| do_update ​      | Habilitar ou desabilitar a atualização de firmware ​         | Booleano | Sim          |
 +
 +== Exemplo do Body ==
 +
 +<​code>​
 +{
 +  "​do_update":​ true
 +}
 +</​code>​
 +
 +
 +== Retorno da Requisição ==
 +^ Status Code ^ Descrição ​                                                        ^
 +| 200         | OK, alteração feita com sucesso ​                                  ​| ​
 +| 500         | Erro no servidor, mais informações no body da mensagem de retorno |
 +
 +== Exemplos de Retorno ==
 +<​code>​
 +{
 +  "​success":​ false,
 +  "​message":​ "Erro ao encontrar dispositivo"​
 +}
 +</​code>​
 +
 +<​code>​
 +{
 +  "​success":​ true
 } }
 </​code>​ </​code>​
Linha 179: Linha 232:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                            ​
-| 200 | OK, roteador foi deletado com sucesso |  +| 200         ​| OK, roteador foi deletado com sucesso |  
-| 500 | Erro interno do servidor |+| 500         ​| Erro interno do servidor ​             |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 233: Linha 286:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                                                        ​
-| 200 | OK, roteador criado com sucesso |  +| 200         ​| OK, roteador criado com sucesso ​                                  ​|  
-| 500 | Erro no servidor, mais informações no body da mensagem de retorno |+| 500         ​| Erro no servidor, mais informações no body da mensagem de retorno |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 289: Linha 342:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                            ​
-| 200 | OK, comando executado com sucesso ​    |  +| 200         ​| OK, comando executado com sucesso ​    |  
-| 500 | Erro interno do servidor ​             | +| 500         ​| Erro interno do servidor ​             | 
-| 404 | Comando ou roteador não encontrado ​   |+| 404         ​| Comando ou roteador não encontrado ​   |
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 323: Linha 376:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                            ​
-| 200 | OK, comando executado com sucesso ​    |  +| 200         ​| OK, comando executado com sucesso ​    |  
-| 500 | Erro interno do servidor ​             | +| 500         ​| Erro interno do servidor ​             | 
-| 404 | Roteador não encontrado ​   |+| 404         ​| Roteador não encontrado ​              ​|
  
 == Exemplos de Retorno == == Exemplos de Retorno ==
Linha 361: Linha 414:
  
 == Retorno da Requisição == == Retorno da Requisição ==
-^ Status Code ^ Descrição ^ +^ Status Code ^ Descrição ​                            ​
-| 200 | OK, comando executado com sucesso ​    |  +| 200         ​| OK, comando executado com sucesso ​    |  
-| 500 | Erro interno do servidor ​             | +| 500         ​| Erro interno do servidor ​             | 
-| 404 | Roteador não encontrado ​   |+| 404         ​| Roteador não encontrado ​              ​|
  
 == Exemplos de Retorno == == Exemplos de Retorno ==