Breadcrumbs

GetSiteDivisions - MPS

  • Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx

  • MPS Versão: A partir da 5.5.0

Descrição

Este método retorna uma lista de departamentos que estão cadastrados no site de uma empresa especificada na chamada. Caso não informado a empresa será retornado de todas do provedor. Caso não informado o Site será retornado de todos os sites.

Sintaxe

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

SiteID

Número

Não

-

-

-

ID do site da empresa que deseja buscar os departamentos. Obtido através do método GetSites

Campos de retorno

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

SiteDivisionID

Identificação do departamento no sistema

SiteDivisionName

Nome do departamento

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.