IN CadastroAcompanhamento.integrador: mudanças entre as edições

De CIGAM WIKI
Linha 268: Linha 268:
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarAcompanhamentos</b></font></td>
    </tr>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*codigoEmpresa
** Tipo: String 6
*embarquePedido
** Tipo: String
** Embarque/Pedido/OC. Obrigatório quando não informado contatoOsLanc.
*contatoOsLanc
** Tipo:
** Contato/OS/Lançamento/NF. Obrigatório quando não informado embarquePedido.
*sequenciaItem
** Tipo: Int
*tipoAcompanhamento
** Tipo: String
*dataInicial
** Tipo: Date
*dataFinal
** Tipo: Date
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6
*embarquePedido
** Tipo: String
** Embarque/Pedido/OC.
*contatoOsLanc
** Tipo:
** Contato/OS/Lançamento/NF.
*sequenciaItem
** Tipo: Int
*tipoAcompanhamento
** Tipo: String
*codigoTitulo
** Tipo: String
*dataPrevista
** Tipo: Date
*dataRealizada
** Tipo: Date
*horaPrevista
** Tipo: time 6
*horaRealizada
** Tipo: time 6
*remessas
** Tipo: String
*sequenciaContato
** Tipo: Int
*usuario
** Tipo: String 3
*data
** Tipo: Date
*hora
** Tipo: time 6
*codigoContatante
** Tipo: String
*historico
** Tipo: String
*assunto
** Tipo: String
*para
** Tipo: String
*cc
** Tipo: String
*anexos
** Tipo: String
*link
** Tipo: String
*textoLink
** Tipo: String
*restrito
** Tipo: Bool
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
{{VoltarInicio}}</td>
     </tr>
     </tr>
</table></center>
</table></center>

Edição das 20h23min de 6 de outubro de 2026

Voltar
Integrador > WebServices > IN CadastroAcompanhamento.integrador

Requisição

Métodos

Cadastrar

Parâmetros:



Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

CadastrarAcompanhamentos

Método que tem por finalidade cadastrar Acompanhamentos. Os dados do Acompanhamento deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

Parâmetros:



Distribuição das Tags XML:



Distribuição das Tags Json:



Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

Excluir

Parâmetros:



Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

Voltar ao início

ListarAcompanhamentos

Parâmetros:



Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início