Método gravarAglomeracao
- Objetivo do Método:
Inscrever informações de uma Aglomeração. Para realizar uma alteração em um registro, basta que o método de inserção seja usado. O WS ao localizar um registro já existente irá realizar o merge (mescla) das informações, atualizando os dados.
- Pré-condição:
- Pessoa Física cadastrada
- Pessoa Jurídica cadastrada
- Estabelecimento Rural cadastrado
- Campos de Entrada:
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
ID_AGLOMERACAO |
NUMBER(10) |
PK |
|
Identificador único |
|
NR_CNPJ |
VARCHAR(18) |
|
|
CNPJ do responsável pela organização do evento |
|
NR_CNPJ_PROMOTOR |
VARCHAR(18) |
|
|
CNPJ do promotor do evento |
|
NR_CPF |
VARCHAR(14) |
|
|
CPF do responsável pela organização do evento |
|
NR_CPF_PROMOTOR |
VARCHAR(14) |
|
|
CPF do promotor 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 |
|
ID_ENDERECO_AGLOMERACAO |
VARCHAR(2) |
|
|
Tipo de Endereço da Aglomeração (Item 3.2.33) |
|
ID_TIPO_EVENTO |
VARCHAR(2) |
|
|
Tipo do Evento (Item 3.2.7) |
|
NM_EVENTO |
VARCHAR(60) |
|
|
Nome do evento |
|
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) |
|
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) |
|
0 |
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) |
|
SYS_KEY |
VARCHAR(39) |
|
|
Chave de sistema do estado correspondente ao ambiente |
- Campos de Saída:
Nome do Campo |
Tipo de Dados |
Observação |
|
Mensagem de Retorno |
Ver Item 3.1 |
- 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:gravarAglomeracao>
<!--Optional:-->
<idAglomeracao>5300000001</idAglomeracao>
<!--Optional:-->
<nrCpf>33456871198</nrCpf>
<!--Optional:-->
<nrCpfPromotor>33456871198</nrCpfPromotor>
<!--Optional:-->
<idMunicipioIbge>5300108</idMunicipioIbge>
<!--Optional:-->
<idUf>53</idUf>
<!--Optional:-->
<idPropriedade>53000000001</idPropriedade>
<!--Optional:-->
<idEnderecoAglomeracao>PR</idEnderecoAglomeracao>
<!--Optional:-->
<idTipoEvento>01</idTipoEvento>
<!--Optional:-->
<nmEvento>Evento Teste 1</nmEvento>
<!--Optional:-->
<dsSituacao>1</dsSituacao>
<!--Optional:-->
<dtInicio>01012021</dtInicio>
<!--Optional:-->
<dtFim>01022021</dtFim>
<!--Optional:-->
<nmPromotorEvento>Promotor Teste Evento 1</nmPromotorEvento>
<!--Optional:-->
<nmPaginaWeb>alglomeracaoteste.com</nmPaginaWeb>
<!--Optional:-->
<nmEmail>testeAglomeracao@teste.com</nmEmail>
<!--Optional:-->
<inCondicaoBloqueio>0</inCondicaoBloqueio>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:gravarAglomeracao>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:gravarAglomeracaoResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return><mensagem>MS0001</mensagem><status>SUCESSO</status></return>
</ns2:gravarAglomeracaoResponse>
</S:Body>
</S:Envelope>