-
Web Service URL: https://[SERVER_ADDRESS]/ContractsWS/ContractsData.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Traz todos os contratos que estão no provedor. Somente retorna os contratos em que o usuário tenha permissão na empresa informada.
Sintaxe
public string RetrieveContracts(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 |
Não |
- |
- |
- |
Número identificador da empresa. Obtido através do método GetEnterprises |
Campos de retorno
|
Nome do campo |
Descrição |
|
ContractID |
Identificador do contrato no sistema |
|
ContractAlias |
Nome de identificação (apelido) do contrato |
|
ContractNumber |
Número do contrato |
|
EnterpriseID |
Identificador da empresa no sistema |
|
EnterpriseName |
Nome da empresa no sistema |
|
ContractPrinters |
Quantidade de equipamentos contratados esperados no contrato |
|
Actived¹ |
Indica se o contrato está ativo, retorna true ou false |
¹ Passou a retornar esse campo a partir da versão 5.11.0.
Clique aqui para saber mais sobre o formato dos retornos.
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
Para executar este método, o usuário informado precisa ser Administrador no provedor.