-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Este método cadastra ou atualiza um site em uma empresa do provedor. Quando é informado o nome de um site que ainda não existe na empresa o método irá cadastrá-lo. Se for informado o nome de um site já cadastrado o método irá atualizar os dados de endereço do site.
Sintaxe
public string ImportSite(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 onde o site será criado. Obtido através do método GetEnterprises |
|
SiteName |
Texto |
Sim |
- |
- |
255 |
Nome do site a ser criado ou atualizado |
|
CountryName |
Texto |
Sim |
- |
- |
100 |
País onde o site se encontra |
|
StateName |
Texto |
Sim |
- |
- |
100 |
Estado onde o site se encontra |
|
CityName |
Texto |
Sim |
- |
- |
100 |
Cidade onde o site se encontra |
|
Street |
Texto |
Sim |
- |
- |
255 |
Nome da rua onde o site se encontra |
|
Neighborhood |
Texto |
Não |
- |
- |
100 |
Nome do bairro onde o site se encontra |
|
PostalCode |
Texto |
Não |
- |
- |
20 |
Número código postal do site |
|
Number |
Número |
Não |
- |
- |
- |
Número do local onde o site se encontra |
|
AdditionalInfo |
Texto |
Não |
Sim |
Sim |
255 |
Novas informações adicionais de onde o site se encontra |
Caracteres não permitidos nos parâmetros e o erro que será retornado
|
Parâmetro |
Caracteres não permitidos |
Erro |
|
siteName |
,|'+ |
ERR_DATA_INVALIDSITENAME |
|
countryName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDCOUNTRYNAME |
|
stateName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDSTATENAME |
|
cityName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDCITYNAME |
|
street |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDSTREET |
|
neighborhood |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDNEIGHBORHOOD |
|
postalCode |
!@#$%¨&*=§[]{}ºª?/°;:><\/+.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDPOSTALCODE |
Retorno
Se obtiver sucesso, o retorno é: [{"SiteID":number}], onde number é o número identificador no novo site inserido.
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.