Método baixarGtaEmitida
- Objetivo do Método:
Fazer o recebimento de Gta Emitida. Para realizar um recebimento a Gta Emitida deve ter o Status igual a "EM TRANSITO". Apenas os Estados de Origem e Destino estão aptos para realizarem a baixa da Gta Emitida.
- Pré-condição:
A Gta Emitida está em Trânsito.
O recebimento ou baixa da Gta Emitida só poderá ser feita pelo Estado de Origem ou pelo Estado de Destino da Gta Emitida.
- Campos de Entrada:
Atributo |
Tipo de Dados |
Chave |
Regras |
Valor Padrão |
Observação |
ID_PROTOCOLO_GTA_EMITIDA |
VARCHAR(19) |
PK |
|
Identificador único |
|
SYS_KEY |
VARCHAR(39) |
|
|
Chave de sistema do estado correspondente ao ambiente |
|
listGtaEmitidaEstratificacao |
Lista |
|
|
|
|
ID_GTA_EMITIDA_ESTRATIFICACAO |
NUMBER(10) |
|
|
Identificador único para gta emitida estratificação |
|
ID_ESTRATIFICACAO |
VARCHAR(6) |
|
|
Identificador de estratificação (Item 3.2.11) |
|
QT_ENVIADA |
NUMBER(10) |
|
|
|
Quantidade enviada |
QT_RECEBIDA |
NUMBER(10) |
|
|
|
Quantidade recebida |
- 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:baixarGtaEmitida>
<!--Optional:-->
<idProtocoloGtaEmitida>WS530000000005.2021</idProtocoloGtaEmitida>
<!--Zero or more repetitions:-->
<listGtaEmitidaEstratificacao>
<!--Optional:-->
<estratificacao>
<!--Optional:-->
<idEstratificacao>1.1.2</idEstratificacao>
</estratificacao>
<!--Optional:-->
<idGtaEmitidaEstratificacao>5300000010</idGtaEmitidaEstratificacao>
<qtEnviada>100</qtEnviada>
<qtRecebida>100</qtRecebida>
</listGtaEmitidaEstratificacao>
<!--Optional:-->
<sysKey>{Syskey do Estado}</sysKey>
</web:baixarGtaEmitida>
</soapenv:Body>
</soapenv:Envelope>
- Exemplo de XML de Saída:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:baixarGtaEmitidaResponse xmlns:ns2="http://webservice.ws.pga.id2.inf.br/">
<return>
<descricaoMensagem>Registro Atualizado Com Sucesso!</descricaoMensagem>
<mensagem>MS0002</mensagem>
<status>SUCESSO</status>
</return>
</ns2:baixarGtaEmitidaResponse>
</soap:Body>
</soap:Envelope>