Método consultaExistenciaPtvDocumentos
- Objetivo do Método:
Consulta a existência de registro de Documentos da Ptv. O método de consulta existência irá apenas retornar se o registro procurado existe ou não.
Esse método não valida Regras de Negócio para existência do registro, apenas retorna se o registro, baseado em seu ID, existe no WS.
- Pré-condição:
Ter inserido o registro de Documentos da Ptv.
- Campos de Entrada:
|
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
|
ID_PTV_DOCUMENTOS |
NUMBER(10) |
PK |
|
Identificador único do Registro |
|
|
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:consultaExistenciaPtvDocumentos>
<!--Optional:-->
<idPtvDocumentos>5300000001</idPtvDocumentos>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:consultaExistenciaPtvDocumentos>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:consultaExistenciaPtvDocumentosResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return><mensagem>MS0003</mensagem>
<status>SUCESSO</status></return>
</ns2:consultaExistenciaPtvDocumentosResponse>
</S:Body>
</S:Envelope>