Voltar
Integrador >
WebServices >
IN CadastroAcompanhamento.integrador
Requisição
Métodos
| Cadastrar |
Parâmetros:
{"minExpandLevel":2} - pin
- Obrigatório, Tipo: String 20
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P,
- por padrão, será cadastrado como P na tabela de integração.
- codigoEmpresa
- 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
- tipoAcompanhamento
- codigoTitulo
- dataPrevista
- dataRealizada
- horaPrevista
- Tipo: time 6
- Formato HHMMSS (também aceita HH:MM ou HH:MM:SS)
- horaRealizada
- Tipo: time 6
- Formato HHMMSS (também aceita HH:MM ou HH:MM:SS)
- remessas
- sequenciaContato
- contato
- data
- hora
- Tipo: time 6
- Formato HHMMSS (também aceita HH:MM:SS)
- codigoContatante
- historico
- assunto
- para
- cc
- anexos
- link
- textoLink
- restrito
- Tipo: Bool
- Passar true (S) ou false (N).
- Se não informado, será considerado false.
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:
{"minExpandLevel":2} - pin
- Obrigatório, Tipo: String 20
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P,
- por padrão, será cadastrado como P na tabela de integração.
- acompanhamentosXml
- Obrigatório para requisições SOAP. Tipo: String
- Caminho de um arquivo XML com os Acompanhamentos.
- acompanhamentosJson
- Obrigatório para requisições REST/JSON. Tipo: String
- Conteúdo de um arquivo JSON com os Acompanhamentos.
Distribuição das Tags XML:
{"":true} - <cadastroAcompanhamento>
- <acompanhamentos>
- <acompanhamento>
- <codigoEmpresa>
- <embarquePedido>
- <contatoOsLanc>
- <sequenciaItem>
- <tipoAcompanhamento>
- <codigoTitulo>
- <dataPrevista>
- <dataRealizada>
- <horaPrevista>
- <horaRealizada>
- <remessas>
- <sequenciaContato>
- <contato>
- < data>
- <hora>
- <codigoContatante>
- <historico>
- <assunto>
- <para>
- <cc>
- <anexos>
- <link>
- <textoLink>
- <restrito>
- </acompanhamento>
- </acompanhamentos>
- </cadastroAcompanhamento>
Distribuição das Tags Json:
- {
- "acompanhamentos": [
- {
- "codigoEmpresa": "",
- "embarquePedido": "",
- "contatoOsLanc": ,
- "sequenciaItem": ,
- "tipoAcompanhamento": "",
- "codigoTitulo": "",
- "dataPrevista": "",
- "dataRealizada": "",
- "horaPrevista": "",
- "horaRealizada": "",
- "remessas": "",
- "sequenciaContato": ,
- "contato": "",
- "data": "",
- "hora": "",
- "codigoContatante": "",
- "historico": "",
- "assunto": "",
- "para": "",
- "cc": "",
- "anexos": "",
- "link": "",
- "textoLink": ""
- }
- ]
- }
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:
{"minExpandLevel":2} - pin
- Obrigatório, Tipo: String 20
- codigoEmpresa
- 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
- tipoAcompanhamento
- data
- hora
- Tipo: time 6
- Formato HHMMSS (também aceita HH:MM:SS)
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:
{"minExpandLevel":2} - pin
- Obrigatório, Tipo: String 20
- codigoEmpresa
- 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
- tipoAcompanhamento
- dataInicial
- dataFinal
Retornos:
Se sucesso:
{"minExpandLevel":2} - codigoEmpresa
- embarquePedido
- Tipo: String
- Embarque/Pedido/OC.
- contatoOsLanc
- Tipo:
- Contato/OS/Lançamento/NF.
- sequenciaItem
- tipoAcompanhamento
- codigoTitulo
- dataPrevista
- dataRealizada
- horaPrevista
- horaRealizada
- remessas
- sequenciaContato
- usuario
- data
- hora
- codigoContatante
- historico
- assunto
- para
- cc
- anexos
- link
- textoLink
- restrito
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 |