Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Conforme solicitação do Cassiano: Retirar da documentação o método “delete”, é um recurso que não possuímos mais a exclusão de empresas e pode causar problemas.

...

Warning
titleAtenção

O serviço SOAP será depreciado a partir da atualização 1.6.5. A recomendação é utilizar a API REST ou nosso componente SDK.

...

Cloak
visibletrue
titleNo quadro 9, é mostrado todos os métodos disponíveis na classe CompanyService.

createCompany

Cria uma empresa no fluig.


Método:

createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • description: descrição da empresa.
  • urlAccessName: URL de acesso.
  • phisicalPath: caminho físico.
  • webdeskServer: servidor.
  • webPort: porta.


Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


delete

Exclui uma empresa do fluig.

Método:

delete(String username, String password, String companyId, Boolean deleteFiles)

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • deleteFiles: indica se deve excluir o caminho físico.

Retorno: String.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getCompanies

Retorna todas as empresas cadastradas no fluig.


Método:

getCompanies(String username, String password, String companyId)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.


Retorno: CompanyDto[].

getCompany

Retorna uma empresa cadastrada no fluig.


Método:

getCompany(int companyId)


Parâmetros:

  • companyId: código da empresa.


Retorno: CompanyDto.

updateCompany

Altera uma empresa no fluig.


Método:

updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • description: descrição da empresa.
  • urlAccessName: URL de acesso.
  • phisicalPath: caminho físico.
  • webdeskServer: servidor.
  • webPort: porta.


Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 9: Métodos da CompanyService


...