-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Este método retorna todas as empresas que o provedor é dono.
Sintaxe
public string GetEnterprises(string properties)
Montagem das propriedades
O conteúdo de string properties deve ser um texto em formato JSON contendo as propriedades abaixo. Por exemplo:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
Não é necessário se preocupar com nomes de propriedades maiúsculos ou minúsculos, o Web Service é Case-Insensitive.
Propriedades aceitas pelo método
|
Propriedade |
Tipo |
Obrigatório |
Permite nulo |
Permite vazio |
Tamanho máximo |
Descrição |
|
DealerName |
Texto |
Sim |
- |
- |
- |
Nome do provedor |
|
DealerUserEmail |
Texto |
Sim |
- |
- |
- |
E-mail do usuário do provedor |
|
DealerUserPassword |
Texto |
Sim |
- |
- |
- |
Senha do usuário criptografada |
|
CNPJ |
Texto |
Não |
- |
- |
- |
CNPJ da empresa. Só precisa ser informado se desejar filtrar pelo CNPJ |
|
FieldsList |
Texto |
Não |
Sim |
Sim |
- |
Lista dos campos que serão retornados pelo método. Devem ser especificados separando-os pelo caractere ‘;’. Exemplo: PrinterDeviceID;SiteID;SiteName. Quando nenhum campo for especificado a resposta conterá os campos que estão em negrito na tabela abaixo |
Campos de retorno reconhecidos em FieldsList
|
Nome do campo |
Descrição |
|
EnterpriseID |
Identificador da empresa no sistema |
|
EnterpriseName |
Nome da empresa no sistema |
|
EnterpriseKey |
Chave da empresa no sistema |
|
CorporateName |
Descrição da empresa |
|
CNPJ |
CNPJ da empresa |
|
AddressCountry |
País onde a empresa está localizada |
|
AddressState |
Estado onde a empresa está localizada |
|
AddressCity |
Cidade onde a empresa está localizada |
|
AddressStreet |
Rua onde se encontra a empresa |
|
AddressNeighborhood |
Bairro onde se encontra a empresa |
|
AddressPostalCode |
CEP onde se encontra a empresa |
|
AddressNumber |
Número de localização da empresa |
|
AddressAdditionalInfo |
Complemento do endereço da empresa |
|
IsMonitored |
Indica se a empresa está monitorada |
Retorno
Clique aqui para saber mais sobre o formato dos retornos.
Possíveis erros retornados
Clique aqui para verificar os possíveis erros que podem ser retornados e conhecer seus motivos.
Restrições
-
Para executar este método, o usuário informado precisa ser Administrador no provedor ou responsável por alguma empresa.