Versions Compared

Version Old Version 15 New Version 16
Changes made by

Former user

Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleOperação: obterSituacaoToken

Retorna a situação do token passado como parâmetro. Para evitar solicitações indefinidas a este serviço o sistema punirá com a remoção do token da fila sempre que for feita duas chamadas seguidas  do serviço obterSituacaoToken em menos de cinco segundos.

Definição:

  • obterSituacaoToken(caracteres token)

Parâmetros:

  • token: o token recebido no serviço obterToken.

Resposta (campos dados):

  • posicao: posição atual do seu token na fila
  • situacao: situação do token

Exemplo

Code Block
languagexml
titleSolicitação (O cabeçalho “soapenv:Header” foi omitido para simplificação da documentação):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/">
 <soapenv:Header…
 <soapenv:Body>
 <tok:obterSituacaoToken>
 <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token>
 </tok:obterSituacaoToken>
 </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleResposta:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:obterSituacaoTokenResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/">
 <return>
 <dados>
 <entry>
 <key>posicao</key>
 <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</value>
 </entry>
 <entry>
 <key>situacao</key>
 <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pronto para envio ou
consulta</value>
 </entry>
 </dados>
 <mensagem>Situação token obtida com sucesso</mensagem>
 <status>OK</status>
 </return>
 </ns2:obterSituacaoTokenResponse>
 </soap:Body>
</soap:Envelope>



Expand
titleOperação: iniciarTransferencia

Antes de iniciar a transferência dos dados propriamente dita será necessário executar o serviço iniciarTransferencia.

Definição:

  • iniciarTransferencia (caracteres token)

Parâmetros:

  •  token: o token recebido no serviço obterToken.

Resposta (campos dados): vazio, não retorna valores.

Exemplo:

Code Block
languagexml
titleSolicitação (O cabeçalho “soapenv:Header” foi omitido para simplificação da documentação):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/">
 <soapenv:Header...
 <soapenv:Body>
 <tok:iniciarTransferencia>
 <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token>
 </tok:iniciarTransferencia>
 </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleResposta:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:iniciarTransferenciaResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/">
 <return>
 <dados/>
 <mensagem>Início de transferência liberado</mensagem>
 <status>OK</status>
 </return>
 </ns2:iniciarTransferenciaResponse>
 </soap:Body>
</soap:Envelope>



Expand
titleOperação: cancelarTransferencia

Ao final da transferência caso queria remover todos os elementos inseridos nesta sessão, ou seja todos os elementos ligados a determinado token passado para o serviço. Uma vez executado este serviço o token atual será descartado.

Definição:

  • cancelarTransferencia (caracteres token)

Parâmetros:

  •  token: o token recebido no serviço obterToken.

Resposta (campos dados): vazio, não retorna valores.

Exemplo:

Code Block
languagexml
titleSolicitação (O cabeçalho “soapenv:Header” foi omitido para simplificação da documentação):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/">
 <soapenv:Header...
 <soapenv:Body>
 <tok:cancelarTransferencia>
 <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token>
 </tok:cancelarTransferencia>
 </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleResposta:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:cancelarTransferenciaResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/">
 <return>
 <dados/>
 <mensagem>Cancelada com sucesso</mensagem>
 <status>OK</status>
 </return>
 </ns2:cancelarTransferenciaResponse>
 </soap:Body>
</soap:Envelope>