-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Este método retorna a lista de sites cadastrados de uma empresa especifica ou todos os sites de todas empresas do parceiro, caso não especifique a empresa.
Sintaxe
public string GetSites(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 |
|
FieldsList |
Texto |
Não |
Sim |
Sim |
- |
Lista dos campos que serão retornados pelo método. Devem ser especificados separando-os pelo caractere ‘;’. Exemplo: PrinterDeviceID;SiteID;SiteName. Quando nenhum campo for especificado a resposta conterá os campos que estão em negrito na tabela abaixo |
Campos de retorno reconhecidos em FieldsList
|
Nome do campo |
Descrição |
|
EnterpriseID |
Identificação da empresa no sistema |
|
EnterpriseName |
Nome da empresa. |
|
SiteID |
Identificação do site no sistema |
|
SiteName |
Nome do site |
|
IsDefault |
Indica de este o site padrão da empresa. True para site definido como padrão e False para os demais sites |
|
StockID |
Identificador do Estoque do cliente que abastece este site |
|
StockName |
Nome do Estoque do cliente que abastece este site |
|
AddressCountry |
País onde o site está localizado |
|
AddressState |
Estado onde o site está localizado |
|
AddressCity |
Cidade onde o site está localizado |
|
AddressStreet |
Rua onde se encontra o site |
|
AddressNeighborhood |
Bairro onde se encontra o site |
|
AddressPostalCode |
CEP onde se encontra o site |
|
AddressNumber |
Número de localização do site |
|
AddressAdditionalInfo |
Complemento do endereço do site |
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.