Método obterAglomeracao
- Objetivo do Método:
Obtêm todos os campos de Aglomeração.
- Pré-condição:
Ter inserido o registro de Aglomerção
- Campos de Entrada:
|
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
|
NR_CNPJ |
VARCHAR(18) |
|
|
CNPJ / Identificador único do registro |
|
|
NR_CPF |
VARCHAR(14) |
|
|
CPF/Identificador Único |
|
|
ID_UF |
NUMBER(2) |
|
|
Número IBGE da UF do local do evento |
|
|
ID_PROPRIEDADE |
VARCHAR(11) |
|
|
Identificador da Propriedade (Estabelecimento) Rural, local do evento |
|
|
NM_EVENTO |
VARCHAR(60) |
|
|
Nome do evento |
|
|
DT_INICIO |
DATE(DDMMAAAA) |
|
|
Data de início do evento |
|
|
DT_FIM |
DATE(DDMMAAAA) |
|
|
Data de finalização do evento |
|
|
SYS_KEY |
VARCHAR(39) |
|
|
Chave de sistema do estado correspondente ao ambiente |
- Campos de Saída:
|
Atributo |
Tipo de Dados |
Observação |
|
ID_AGLOMERACAO |
NUMBER(10) |
Identificador único |
|
NR_CPF_CNPJ_PROMOTOR |
VARCHAR(18) |
CPF ou CNPJ do Promotor |
|
NR_CPF_CNPJ |
VARCHAR(18) |
CPF ou CNPJ do responsável pela organização do evento |
|
ID_MUNICIPIO_IBGE |
NUMBER(7) |
Número IBGE do Município local do evento |
|
ID_UF |
NUMBER(2) |
Número IBGE da UF do local do evento |
|
ID_PROPRIEDADE |
VARCHAR(11) |
Identificador da Propriedade (Estabelecimento) Rural, local do evento, pode ou não ser exibido |
|
ID_TIPO_EVENTO |
VARCHAR(2) |
Tipo do Evento (Item 3.2.7) |
|
DT_INICIO |
DATE(DDMMAAAA) |
Data de início da busca |
|
DT_FIM |
DATE(DDMMAAAA) |
Data de finalização da busca |
|
DS_ENDERECO_ALTERNATIVO |
VARCHAR(150) |
Descrição do endereço alternativo (utilização dependente do Tipo de Endereço), pode ou não ser exibido |
|
NM_PROMOTOR_EVENTO |
VARCHAR(60) |
Nome do promotor do evento |
|
NM_PAGINA_WEB |
VARCHAR(60) |
Página WEB de divulgação do evento |
|
NM_EMAIL |
VARCHAR(250) |
E-mail de contato |
|
IN_CONDICAO_BLOQUEIO |
VARCHAR(1) |
Condição de Bloqueio quanto a receber ou emitir GTA (Item 3.2.26) |
|
DS_SITUACAO |
VARCHAR(7) |
Especifica se o registro está ativo ou inativo (Item 3.2.38) |
- Exemplo de XML de Entrada:
O XML do método, gerado pelo WSDL, apresentará o sinal “?” para as tags. O “?” deverá ser substituído pelo valor do campo correspondente.
IMPORTANTE: Caso o campo não tenha valor, o mesmo não deverá ser enviado, sob pena de geração de erro na tentativa de consumo do método.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.ws.pga.id2.inf.br/">
<soapenv:Header/>
<soapenv:Body>
<web:obterAglomeracao>
<!--Optional:-->
<uf>53</uf>
<!--Optional:-->
<nmEvento>Evento Teste 1</nmEvento>
<!--Optional:-->
<idPropriedadeRural>53000000001</idPropriedadeRural>
<!--Optional:-->
<nrCpf>33456871198</nrCpf>
<!--Optional:-->
<dtInicio>01012021</dtInicio>
<!--Optional:-->
<dtFim>15012021</dtFim>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:obterAglomeracao>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:obterAglomeracaoResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return>
<listaRetorno xsi:type="ns2:aglomeracaoRetorno" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<dsEnderecoAlternativo>Não Informado</dsEnderecoAlternativo>
<dtFim>2011-12-01T00:00:00-02:00</dtFim>
<dtInicio>2011-11-25T00:00:00-02:00</dtInicio>
<idAglomeracao>3200001340</idAglomeracao>
<idTipoEvento>01</idTipoEvento>
<idUf>32</idUf>
<inCondicaoBloqueio>0</inCondicaoBloqueio>
<municipioIbge>3200607</municipioIbge>
<nmEvento>MEGA LEILÃO DE ARACRUZ</nmEvento>
<nmPromotorEvento>Mega Leilões Ltda</nmPromotorEvento>
<nrCpfCnpj>04726588000116</nrCpfCnpj>
<nrCpfCnpjPromotor>04726588000116</nrCpfCnpjPromotor>
</listaRetorno>
<status>SUCESSO</status>
</return>
</ns2:obterAglomeracaoResponse>
</soap:Body>
</soap:Envelope>