Web service com.senior.g5.co.mfi.prj.cadastroprotocolo
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_mfi_prj_cadastroprotocolo?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mfi_prj_cadastroprotocolo?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mfi_prj_cadastroprotocolo?wsdl
Porta
CadastroProtocolo
Finanças - Gestão Orçamentária e Projetos - Controle Financeiro - Cadastro de Protocolo
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:CadastroProtocolo> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <gridProtocolo> <codPtc>Integer</codPtc> <assPtc>String</assPtc> <codRem>Integer</codRem> <codDes>Integer</codDes> <datRec>String</datRec> <infPrc>String</infPrc> <ligaAnexos> <seqApt>Integer</seqApt> <desApt>String</desApt> <camApt>String</camApt> <tipApt>String</tipApt> </ligaAnexos> </gridProtocolo> <codEmp>Integer</codEmp> <excluir>String</excluir> </parameters> </ser:CadastroProtocolo> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
gridProtocolo | Set | HELP:
Equivale a tela de cadastro de protocolo: F615PTC. |
gridProtocolo.codPtc | Integer | Obrigatório somente quando for alteração - Código do protocolo - Numero |
gridProtocolo.assPtc | String | (Obrigatório) - Assunto do protocolo - Caractere(20) |
gridProtocolo.codRem | Integer | (Obrigatório) - Código do remetente - Numero |
gridProtocolo.codDes | Integer | (Obrigatório) - Código do destinatário - Numero |
gridProtocolo.datRec | DateTime | (Obrigatório) - Data de recebimento do documento - Data |
gridProtocolo.infPrc | String | Informações complementares do recebimento do documento - Caractere(120) |
gridProtocolo.ligaAnexos | Set | |
gridProtocolo.ligaAnexos.seqApt | Integer | Obrigatório apenas para alteração - Sequência do anexo do protocolo - Número |
gridProtocolo.ligaAnexos.desApt | String | Descrição do anexo - Caractere(100) |
gridProtocolo.ligaAnexos.camApt | String | Caminho do anexo - Caractere (250) |
gridProtocolo.ligaAnexos.tipApt | String | Tipo do arquivo - Caractere(1) |
codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
excluir | String | String - Operação: (E) Exclusão |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:CadastroProtocoloResponse> <result> <gridResult> <codEmp>String</codEmp> <codPtc>String</codPtc> <seqApt>String</seqApt> <txtRet>String</txtRet> </gridResult> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:CadastroProtocoloResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Descrição |
---|---|---|
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
gridResult | Set | Itens de retorno. |
gridResult.codEmp | String | Integer - Empresa |
gridResult.codPtc | String | Integer -Cod. Protocolo |
gridResult.seqApt | String | String -Linha do Anexo |
gridResult.txtRet | String | String - Retorno |
resultado | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: Inclusão ou Alteração: "OK Execução do serviço com erros: "ERRO". Mensagens do erro, na grid de retorno de erros. |