Breadcrumbs

GetPlainCountersData

  • Web Service URL: https://[SERVER_ADDRESS]/CountersWS/CountersData.asmx

  • MPS Versão: A partir da 5.5.0

Descrição

Este método retorna um registro de cada impressora, informando o primeiro e o último contador de cada tipo registrado nas impressoras e sem nenhum tratamento, conforme os filtros informados.

Sintaxe

public string GetPlainCountersData(string dealerName, string dealerUserEmail, string dealerUserPassword, string dateTimeStart, string dateTimeEnd, int maxLimitDaysEarlier, string enterpriseName, string serialNumber, string siteName, string siteDivisionName, bool engaged, string fieldsList)

Parâmetros

  • dealerName: Nome do provedor;

  • dealerUserEmail: E-mail do usuário do provedor;

  • dealerUserPassword: Senha do usuário criptografada;

  • dateTimeStart: Data inicial que deseja buscar os contadores (formato yyyy-MM-dd HH:mm:ss);

  • dateTimeEnd: Data final que deseja buscar os contadores (formato yyyy-MM-dd HH:mm:ss);

  • maxLimitDaysEarlier: Limite máximo de dias anteriores para considerar;

  • enterpriseName: Nome(s) da(s) empresa(s) que serão buscadas os contadores das impressoras. Pode ser informada uma única empresa para buscar somente os contadores das impressoras que pertencem a esta empresa; pode ser deixado em branco para trazer os contadores das impressoras sem filtrar por sua empresa; ou ser informada uma lista de empresas separadas por ponto e vírgula (;) para buscar somente os contadores das impressoras que pertencem as essas empresas. Exemplo: Emp1;Emp2;Emp3;

  • serialNumber: Número(s) de série(s) da(s) impressora(s) que serão buscadas os contadores. Pode ser informado um único número de série para buscar somente os contadores da impressora que contém este número de série; pode ser deixado em branco para trazer os contadores sem filtrar pelo número de série; ou informar uma lista de números separados por ponto e vírgula (;) para buscar somente os contadores nas impressoras que contém os números de séries informados. Exemplo: SNImp1;SNImp1;SNImp1;

  • siteName: Nome(s) do(s) site(s) onde serão buscados os contadores das impressoras. Pode ser informado um único site para buscar somente os contadores das impressoras que pertencem a este site; pode ser deixado em branco para trazer os contadores das impressoras sem filtrar pelo seu site; ou ser informado uma lista de sites separados por ponto e vírgula (;) para buscar somente os contadores de impressoras que pertencem a estes sites. Exemplo: Site1;Site2;Site3;

  • siteDivisionName: Nome(s) do(s) departamento(s) onde serão buscados os contadores das impressoras. Pode ser informando um único departamento para buscar somente os contadores das impressoras que pertencem a este departamento; pode ser deixado em branco para trazer os contadores sem filtrar pelo seu departamento; ou ser informada uma lista de departamentos separados por ponto e vírgula (;) para buscar somente os contadores das impressoras que pertencem a estes departamentos. Exemplo: Depart1;Depart2;Depart3;

  • engaged: Ao informar como true, traz os contadores somente de impressoras de contrato, incluindo as impressoras sem movimentação no período informado. Ao informar false, traz os contadores de todas impressoras;

  • fieldsList: Lista dos campos que serão retornados pelo método. Devem ser especificados separando-os pelo caractere ‘;’. Exemplo: PrinterDeviceName;SerialNumber;AddressName.

Campos reconhecidos em fieldsList

Nome do campo

Descrição

EnterpriseName

Nome da empresa

EnterpriseID

Número identificador da empresa

PrinterDeviceName

Nome da impressora

PrinterModelName

Modelo da impressor

PrinterDeviceID

Número identificador da impressora

SerialNumber

Número de série da impressora

AddressName

Endereço IP da impressora

BrandName

Fabricante da impressora

Location

Localização da impressora

SiteName

Site qual a impressora pertence

SiteDivisionName

Departamento qual a impressora pertence ou - para impressoras que não pertencem a nenhum departamento

EnabledCounters

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

Engaged

True para impressoras de contrato e False para impressoras fora de contrato

IsSuspended

Indica se a impressora está suspensa

ContractNumber

Número do contrato definido para a impressora

AssetNumber

Número do patrimônio definido para a impressora

CounterTypeName

Nome do tipo do contador

FirstDateTimeRead

Data de leitura do contador inicial

LastDateTimeRead

Data de leitura do contador final

FirstCounterTotal

Primeiro contador total no período informado

LatestCounterTotal

Último contador total no período informado

FirstCounterMono

Primeiro contador mono no período informado

LatestCounterMono

Último contador mono no período informado

FirstCounterColor

Primeiro contador color no período informado

LatestCounterColor

Último contador color no período informado

Exemplo de retorno recebido

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

O método retorna somente os contadores das impressoras que o usuário tem permissão para visualizar, ou seja, é necessário que o mesmo monitore a empresa ou site que a impressora que deseja visualizar os contadores pertence.