Método obterEspecieUso
- Objetivo do Método:
Obtêm a entidade Espécie USO
- Pré-condição:
Ter inserido o registro de Espécie Uso
- Campos de Entrada:
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
NM_ESPECIE_USO |
VARCHAR(60) |
|
|
Nome comercial da espécie em uso |
|
ID_ESPECIE_VEGETAL |
NUMBER(10) |
|
|
Identificador da espécie vegetal em uso |
|
ID_USO_PROPOSTO |
NUMBER(10) |
|
|
Identificador do uso proposto vegetal |
|
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 |
Mensagem de Retorno |
|
Status |
Status do Retorno |
ERRO: Quando há alguma falha no resultado, ou o resultado esperado não é alcançado SUCESS: Quando o resultado esperado é alcançado |
- 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:obterEspecieUso>
<!--Optional:-->
<nmEspecieUso>Teste Espécia Uso</nmEspecieUso>
<!--Optional:-->
<idEspecieVegetal>530</idEspecieVegetal>
<!--Optional:-->
<idUsoProposto>1</idUsoProposto>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:obterEspecieUso>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:obterEspecieUsoResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return>
<listaRetorno xsi:type="ns2:especieUsoRetorno" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">{entidade}
</listaRetorno>
<status>SUCESSO</status>
</return>
</ns2:obterEspecieUsoResponse>
</soap:Body>
</soap:Envelope>