Breadcrumbs

RegisterContractPrinter

Descrição

Realiza a criação de uma impressora dentro do fluxo de contratos da empresa.

  • Caso a impressora já exista e esteja removida, ela é inserida novamente¹ e garante que a mesma faça parte do fluxo de contratos;

  • Se a impressora já existe e não faz parte de um fluxo de contratos, a mesma é inserida no fluxo. Para esses casos, se só existir um contrato na empresa, a impressora será inserida automaticamente no contrato.

    • Se a impressora estiver em um fluxo de contratos, seu número de patrimônio será atualizado, caso seja informado;

    • O contato da impressora será sempre atualizado, caso seja informado.

¹ É inserida a impressora removida novamente somente a partir da versão 5.11.0.

Sintaxe 

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

PrinterDeviceName

Texto

Sim

-

-

-

Nome da impressora

SerialNumber

Texto

Sim

-

-

-

Número de série da impressora

BrandName

Texto

Sim

-

-

-

Nome do fabricante

ModelName

Texto

Sim

-

-

-

Modelo da impressora

AssetNumber

Texto

Não

Sim

-

255

Número do patrimônio

IsPartnerPrinter

Lógico

Sim

-

-

-

Se a impressora é do parceiro. Informar o valor verdadeiro ou falso

PrinterContact

Texto

Não

-

Sim

255

Contato da impressora

Retorno

Se obtiver sucesso, o retorno é: [{"PrinterDeviceID":number}], onde number é o número identificador da impressora inserida.

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.