Webservice (Autenticação Usuários - Buscar empresas disponíveis para o usuário): mudanças entre as edições

De Adapter
Ir para navegação Ir para pesquisar
VisualWikitexto
Sem resumo de edição
Sem resumo de edição
 
Linha 1: Linha 1:


'''Descrição:''' Busca as empresas disponíveis para o usuário


'''URL:''' https://[URL]/ws/terceiros/empresas/usuario/{idUsuario}


'''Método:''' GET


'''Entrada:''' Header: ''Token <nowiki>{{token}}</nowiki>, Authorization Basic <nowiki>{{authorization}}</nowiki>,'' Path Param: idUsuario.


'''Saída:''' JSON contendo lista de empresas disponíveis para aquele usuário ou JSON contendo mensagem de erro.


'''Campos JSON de entrada:'''
{| class="wikitable"
|'''Tag'''
|'''Tipo Parâmetro'''
|'''Tipo'''
|'''Obrigatório'''
|'''Observação'''
|-
|Authorization
|header
|String
|SIM
|
|-
|Token
|header
|String
|SIM
|
|-
|idUsuario
|Path Param
|Integer
|SIM
|
|}
'''Exemplo:'''


 
* '''Envio:'''
 
** https://[URL]/ws/terceiros/empresas/usuario/{idUsuario}
 
*** '''Parâmetros adicionais:''' Não possui.
 
* '''Retorno:'''
 
** '''Sucesso:'''<syntaxhighlight lang="json" line="1">
 
{
 
  "resposta":[
 
      {
 
        "id":1,
 
        "nome":"EMPRESA A",
        "nomeFantasia":"EMPRESA A",
        "cnpj":"58783342000105"
      },
      {
        "id":2,
        "nome":"EMPRESA B",
        "nomeFantasia":"EMPRESA B",
        "cnpj":"16822118000135"
      }
  ]
}
</syntaxhighlight>
** '''Erro:'''<syntaxhighlight lang="json" line="1">
{
  "error":"Internal Server Error"
}
</syntaxhighlight>


[[Webservice (Autenticação Usuários)|Voltar ao menu Webservice Autenticação Usuários]]
[[Webservice (Autenticação Usuários)|Voltar ao menu Webservice Autenticação Usuários]]

Edição atual tal como às 13h33min de 17 de maio de 2023

Descrição: Busca as empresas disponíveis para o usuário

URL: https://[URL]/ws/terceiros/empresas/usuario/{idUsuario}

Método: GET

Entrada: Header: Token {{token}}, Authorization Basic {{authorization}}, Path Param: idUsuario.

Saída: JSON contendo lista de empresas disponíveis para aquele usuário ou JSON contendo mensagem de erro.

Campos JSON de entrada:

Tag Tipo Parâmetro Tipo Obrigatório Observação
Authorization header String SIM
Token header String SIM
idUsuario Path Param Integer SIM

Exemplo:

  • Envio:
    • https://[URL]/ws/terceiros/empresas/usuario/{idUsuario}
      • Parâmetros adicionais: Não possui.
  • Retorno:
    • Sucesso:
      {
   "resposta":[
      {
         "id":1,
         "nome":"EMPRESA A",
         "nomeFantasia":"EMPRESA A",
         "cnpj":"58783342000105"
      },
      {
         "id":2,
         "nome":"EMPRESA B",
         "nomeFantasia":"EMPRESA B",
         "cnpj":"16822118000135"
      }
   ]
}
    • Erro:
      {
   "error":"Internal Server Error"
}

Voltar ao menu Webservice Autenticação Usuários

Disponível em “http://192.168.0.28:80/wiki/index.php?title=Webservice_(Autenticação_Usuários_-_Buscar_empresas_disponíveis_para_o_usuário)&oldid=1584”