Breadcrumbs

GetPrinters - ATUALIZADA

  • Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx

  • MPS Versão: A partir da 5.5.0

Descrição

Este método retorna uma lista com todas as impressoras da empresa especificada na chamada.

Sintaxe

public string GetPrinters(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

Sim

-

-

-

Número identificador da empresa. Obtido através do método GetEnterprises

SerialNumber

Texto

Não

-

-

-

Número de série da impressora. Só precisa ser informado se desejar filtrar pelo número de série. Obtido através do método GetPrinters

FilterField (novo)

Texto

Não

Não

Não

-

Permite  informar um campo específico para aplicar um filtro de dados, retornando apenas os resultados compatíveis com o filtro. Deve ser informado o campo seguido do sinal de igual "=" e o valor a ser pesquisado ex.: "FilterField":"campo=valordePesquisaDesejado". Confira na tabela de retorno abaixo os campos e valores permitidos

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

Permite Filtrar²

Descrição

EnterpriseID¹

-

Identificador da empresa no sistema

EnterpriseName¹

-

Nome da empresa no sistema

PrinterDeviceID

Sim

Identificador da impressora no sistema. O identificador é válido apenas para a empresa informada na chamada, pois o mesmo identificador pode se repetir em outra empresa

SiteID

Sim

Identificador do site qual a impressora pertence

SiteName

-

Nome do site qual a impressora pertence

SiteDivisionID

Sim

Identificador do departamento qual a impressora pertence (-1  para impressoras que estão sem departamento definido)

SiteDivisionName

-

Nome do departamento qual a impressora pertence (Vazio para impressoras que estão sem departamento)

PrinterName

-

Nome da impressora

BrandName

-

Nome do fabricante da impressora

ModelName

-

Nome do modelo da impressora

SerialNumber

-

Número de série da impressora

AddressName

-

IP da impressora

AddressMac

-

MAC da impressora

Location

-

Localização física da impressora

Engaged

Sim

Indica se a impressora é de contrato, True para impressoras de contrato e False para impressoras fora de contrato

EnabledBilling

Sim

Indica se a impressora está com contabilização de páginas habilitada, True quando habilitada e False quando desabilitada

EnabledCounters

Sim

Indica se essa impressora está com monitoração de contadores habilitada, True quando habilitada e False quando desabilitada

IsSuspended

Sim

Indica se a impressora está suspensa, True quando está supensa e False quando não está suspensa

ReceivedDataWhenSuspended

-

Indica se a impressora recebeu dados por arquivos NSL depois de ser suspensa, True quando recebeu e False quando não recebeu

ReplacementFlowDisabled

-

Indica se está forçado a remoção da impressora do fluxo de reposição, True quando está forçado e False quando não está

Disconnected

-

Indica o modo de operação da impressora, True se está no modo manual e False se está no modo automático

ContractNumber

Sim

Número do contrato definido para a impressora

AssetNumber

Sim

Número do patrimônio definido para a impressora

ContactData

-

Informações do contato da impressora

FirmwareVersion

-

Versão do Firmware da impressora (caso a impressora tenha mais que um firmware, o separador padrão é o caracter '¬'. Exemplo: "A3PE0Y0-000¬A3PE0Y0-111")

LastNSLDate

-

Data da última leitura de contadores da impressora

CustomFields¹

-

Quando solicitado, são retornados todos os campos configuráveis ativos do provedor

¹ Somente a partir da versão 5.10.0.

² Campos permitidos para utilização na propriedade FilterField, disponível a partir da versão 5.71.0.

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 Monitor da empresa ou Monitor do site da empresa, da qual as impressoras pertençam.