-
Web Service URL: https://[SERVER_ADDRESS]/PrintHostsWS/PrintHostsData.asmx
-
MPS Versão: A partir da 5.40.0
Descrição
Este método retorna os print hosts do parceiro.
Sintaxe
public string GetPrintHosts(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 |
|
EnterpriseID |
Número |
Não |
- |
- |
- |
Número identificador da empresa. Obtido através do método GetEnterprises |
|
FieldsList |
Texto |
Não |
Sim |
Sim |
- |
Lista dos campos que serão retornados pelo método. Devem ser especificados separando-os pelo caractere ‘;’. Exemplo: EnterpriseID;PrintHostID;MachineName. 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 |
Identificação da empresa no sistema |
|
PrintHostID |
Identificação do print host no sistema |
|
PrintHostKey |
Chave do print host |
|
ConfigMode |
Indica o modo de operação do print host (0 - nuvem, 1 - migrando, 2 - local) |
|
MachineName |
Nome do servidor onde o print host está instalado |
|
OperationalSystem |
Sistema Operacional do servidor onde o print host está instalado |
|
PrintHostVersion |
Versão do print host |
|
Removed |
Indica se o print host está removido |
|
Uninstalled |
Indica se o print host está desinstalado |
|
Deactivated |
Indica se o print host está desativado |
|
CustomFields |
Quando solicitado, são retornados todos os campos adicionais configurados do print host |
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.