Breadcrumbs

RetrieveOutOfContractStatus

  • Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx

  • MPS Versão: A partir da 5.5.0

Descrição

Retorna os status cadastrados pelo provedor que indicam situações onde o equipamento encontra-se fora de um contrato. Essa informação pode ser usada no momento de cadastrar um novo equipamento, informando o status atual do equipamento no cadastro.

Sintaxe

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

Campos de retorno

Nome do campo

Descrição

ContractStatusID

Identificar do status da impressora ao sair de um contrato

ContractStatusName

Descrição do status da impressora ao sair de um contrato

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.