Buscando informações das impressoras via integração

Parâmetros

• api_token – parâmetro obrigatório. Token de integração do provedor de outsourcing para o qual deseja-se buscar os dados. Este token pode ser obtido através do menu Configurações > Integração, no site do PrintWayy;
• company_token – parâmetro opcional. Token para identificar de qual cliente os dados devem ser buscados. Cada cliente cadastrado no PrintWayy tem o seu próprio token. O token de cada cliente pode ser consultado através do método de busca de informações de clientes, detalhado anteriormente. Se este parâmetro não for informado, o parâmetro serialNumbers torna-se obrigatório;
• serialNumbers – parâmetro opcional. Deve ser usado para informar o número de série da impressora que se deseja buscar os dados. Poderá ser informado mais de um número de série por requisição, separando-os por vírgula. Caso esse parâmetro não seja informado, serão pesquisadas todas as impressoras do cliente;
• initialDate – parâmetro opcional. Corresponde à data inicial que se deseja pesquisar os contadores. Deverá ser informada no formato DD-MM-AAAA. Se este parâmetro não for informado será utilizada a data atual do servidor do PrintWayy como data inicial;
• endDate – parâmetro opcional. Caso seja informada uma data inicial de pesquisa, deve-se informar a data final. Deverá ser informada no formato DD-MM-AAAA. Se este parâmetro não for informado será utilizada a data atual do servidor do PrintWayy como data final.

Formato das respostas

Todas as respostas às solicitações terão os seguintes campos, que indicam se requisição foi atendida ou não:

• Sucess – valor booleano indicando se requisição foi atendida com sucesso ou não;
• Code – código que indica o resultado da requisição. Os possíveis códigos de retorno são:
  • 0 – Requisição atendida com sucesso;
  • 1 – O token de API não foi informado ou está incorreto;
  • 2 – O token da empresa cliente não foi informado ou está incorreto;
  • 3 – O período de data informado é inválido;
  • 999 – Erro na solicitação das informações. Tentar novamente.

Quando o processamento da requisição encontrar um ou mais equipamentos de acordo com os parâmetros passados, além dos campos acima, serão retornados as seguintes informações, para cada impressora:

• SerialNumber – número de série do equipamento;
• Department – nome do departamento onde o equipamento se encontra, caso esteja configurado no PrintWayy;
• Location – Localização atual da impressora;
• AssetNumber – Número de patrimônio do equipamento;
• Contract – Nome do contrato associado a impressora.
• IPAddress – endereço IP do equipamento, caso esteja monitorado através da rede;
• GeneralCountStartDateOfCapture – data e hora da primeira captura do contador geral, considerando a data inicial do período informado;
• GeneralCountEndDateOfCapture – data e hora da última captura do contador geral, considerando a data final do período informado;
• GeneralCountStart – valor do contador geral na primeira captura;
• GeneralCountEnd – valor do contador geral na última captura;
• MonoCountStartDateOfCapture – data e hora da primeira captura do contador P&B, considerando a data inicial do período informado;
• MonoCountEndDateOfCapture – data e hora da última captura do contador P&B, considerando a data final do período informado;
• MonoCountStart – valor do contador P&B na primeira captura;
• MonoCountEnd – valor do contador P&B na última captura;
• ColorCountStartDateOfCapture – data e hora da primeira captura do contador colorido, considerando a data inicial do período informad;
• ColorCountEndDateOfCapture – data e hora da última captura do contador colorido, considerando a data final do período informado;
• ColorCountStart – valor do contador colorido na primeira captura;
• ColorCountEnd – valor do contador colorido na última captura;
• ScanCountStartDateOfCapture – data e hora da primeira captura do contador de digitalização, considerando a data inicial do período informado;
• ScanCountEndDateOfCapture – data e hora da última captura do contador de digitalização, considerando a data final do período informado;
• ScanCountStart – valor do contador de digitalização na primeira captura;
• ScanCountEnd – valor do contador de digitalização na última captura;
• A3MonoCountStartDateOfCapture – data e hora da primeira captura do contador P&B A3, considerando a data inicial do período informado;
• A3MonoCountEndDateOfCapture – data e hora da última captura do contador P&B A3, considerando a data final do período informado;
• A3MonoCountStart – valor do contador P&B A3 na primeira captura;
• A3MonoCountEnd – valor do contador P&B A3 na última captura;
• A3ColorCountStartDateOfCapture – data e hora da primeira captura do contador colorido A3, considerando a data inicial do período informado;
• A3ColorCountEndDateOfCapture – data e hora da última captura do contador colorido A3, considerando a data final do período informado;
• A3ColorCountStart – valor do contador colorido A3 na primeira captura;
• A3ColorCountEnd – valor do contador colorido A3 na última captura;
• A3CountStartDateOfCapture – data e hora da primeira captura do contador A3, considerando a data inicial do período informado;
• A3CountEndDateOfCapture – data e hora da última captura do contador A3, considerando a data final do período informado;
• A3CountStart – valor do contador A3 na primeira captura;
• A3CountEnd – valor do contador A3 na última captura;

Observações

• Dependendo do intervalo de datas informado na requisição, é possível que na resposta haja mais de uma ocorrência da mesma impressora. Isso ocorre para os casos em que uma impressora é retirada do cliente e posteriormente é monitorada novamente, nesse mesmo cliente. O PrintWayy trata essa situação separadamente, criando dois registros distintos para cada monitoramento. Dessa forma, ao fazer a pesquisa, a mesma impressora será exibida mais de uma vez na mesma resposta;
• Deve-se ficar atento às datas que são retornadas nas respostas das requisições. As datas sempre correspondem à última informação de contadores recebida para a impressora pesquisada e, por esse motivo, nem sempre corresponderão ao intervalo de datas informado na requisição. Por exemplo: ao fazer uma requisição com intervalo de datas entre 01/10/2015 e 15/10/2015 para uma determinada impressora, e esta impressora recebeu contadores pela última vez no dia 25/09/2015, serão os contadores do dia 25/09 que serão retornados na resposta, sendo essa a data inicial e final que estará na resposta. Essa situação pode, inclusive, sinalizar que há algum problema no monitoramento do equipamento, tendo em vista que os últimos dados recebidos foram apenas no dia 25/09.

Solicitação de informações de uma única impressora, sem informar um período de datas

(Neste caso, são retornadas os últimos contadores que a impressora recebeu)

Requisição:

Resposta:

Solicitação de informações de uma impressora que tem mais de uma passagem no mesmo cliente no intervalo pesquisado

(Neste caso, são retornadas duas ocorrências para o mesmo equipamento)

Requisição:

Resposta:

Pesquisa onde o intervalo de datas está errado e o código na resposta informa que há um erro de data

Requisição:

Resposta:

Para voltar para o menu Integração clique aqui.