IN CadastroAcompanhamento.integrador

Voltar
Integrador > WebServices > IN CadastroAcompanhamento.integrador

Requisição

• Soap: http://servidor/CadastroAcompanhamento.integrador.asmx
• Rest/JSon: http://servidor/CadastroAcompanhamento.integrador.ashx/metodo
  • Tipo de registro: ACOMP

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 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 codigoTitulo Tipo: String dataPrevista Tipo: Date dataRealizada Tipo: Date 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 Tipo: String sequenciaContato Tipo: Int contato Tipo: String 30 data Tipo: Date hora Tipo: time 6 Formato HHMMSS (também aceita HH:MM:SS) 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 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 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 data Tipo: Date 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 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 Retornos:    Se sucesso: {"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    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

ListarPendentes

Parâmetros: {"minExpandLevel":2} pin Obrigatório, Tipo: String 20 statusRegistro Tipo: String 1 L=Liberado, P=Pendente Se for informado algo diferente de P ou L não será aplicado nenhum filtro. acao Tipo: String 1 C=Cadastrar, E=Excluir Se for informado algo diferente de C ou E não será aplicado nenhum filtro Retornos:    Se sucesso: {"minExpandLevel":2} idRegistro Tipo: Int 14 acao Tipo: String 1 statusRegistro Tipo: String 1 dataRequisicao Tipo: Date horaRequisicao Tipo: Int 8 idCorrelato Tipo: Int 14 codigoEmpresa Tipo: String 6 embarquePedido Tipo: String Embarque/Pedido/OC. contatoOsLanc Tipo: Contato/OS/Lançamento/NF. sequenciaItem Tipo: Int tipoAcompanhamento Tipo: String data Tipo: Date hora Tipo: time 6 restrito Tipo: Bool    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

LiberarPendentes

Parâmetros: {"minExpandLevel":2} pin Obrigatório, Tipo: String 20 id Obrigatório, Tipo: Int Retornos:    Se pin inválido:       O usuário não possui direitos suficientes para executar esta rotina.    Se erro na conexão com banco de dados:       A conexão com o banco de dados e/ou comando SQL possui erros.    Se ID inválido ou não encontrado:       Falha ao liberar registro.    Se sucesso:       Sucesso. Voltar ao início