Método obterIdEspecieAprovada
- Objetivo do Método:
Obtêm o Identificador de uma Espécie Aprovada
- Pré-condição:
Ter inserido o registro de Espécie Aprovada
- Campos de Entrada:
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
ID_ETAPA_VACINACAO |
NUMBER(10) |
|
|
Identificador único do registro de Etapa Vacinação |
|
ID_ESTRATIFICACAO |
VARCHAR(6) |
|
|
Identificador de Estratificação (Item 3.2.11) |
|
SYS_KEY |
VARCHAR(39) |
|
|
Chave de sistema do estado correspondente ao ambiente |
- Campos de Saída:
Atributo |
Tipo de Dados |
Observação |
ID_ESPECIE_APROVADA |
NUMBER(10) |
Identificador único |
- 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:obterIdEspecieAprovada>
<!--Optional:-->
<idEtapaVacinacao>01</idEtapaVacinacao>
<!--Optional:-->
<idEstratificacao>1.1.1</idEstratificacao>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:obterIdEspecieAprovada>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:obterIdEspecieAprovadaResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return>
<listaRetorno xsi:type="ns2:especieAprovada" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<idEspecieAprovada>5000001248</idEspecieAprovada>
</listaRetorno>
<status>SUCESSO</status>
</return>
</ns2:obterIdEspecieAprovadaResponse>
</soap:Body>
</soap:Envelope>