Web service com.senior.g5.co.mfi.prj.cadastrofase
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.
- 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
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.
- 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
- 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_cadastrofase?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mfi_prj_cadastrofase?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mfi_prj_cadastrofase?wsdl
Portas
CadFase
Finanças - Gestão Orçamentária e Projetos - Controle Financeiro - Cadastro de Fases
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:CadFase> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <numPrj>Integer</numPrj> <codFpj>Integer</codFpj> <desFpj>String</desFpj> <abrFpj>String</abrFpj> <claFpj>String</claFpj> <datPif>String</datPif> <datPff>String</datPff> <datIfp>String</datIfp> <datFfp>String</datFfp> <perFpj>Double</perFpj> <obsFpj>String</obsFpj> <nivFpj>Integer</nivFpj> <posFpj>Integer</posFpj> <fpjPai>Integer</fpjPai> <anaSin>String</anaSin> <fpjNat>String</fpjNat> <aceRat>String</aceRat> <sitFpj>String</sitFpj> <codMot>Integer</codMot> <obsMot>String</obsMot> <codTns>String</codTns> <tnsCan>String</tnsCan> <tnsSup>String</tnsSup> <tnsDsp>String</tnsDsp> <ctaRed>Integer</ctaRed> <ctaRcr>Integer</ctaRcr> <ctaFdv>Integer</ctaFdv> <ctaFcr>Integer</ctaFcr> <conApr>String</conApr> <cadastroUsuario> <nomCmp>String</nomCmp> <valCmp>String</valCmp> </cadastroUsuario> </parameters> </ser:CadFase> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | Código da empresa do projeto |
numPrj | Integer | Número interno do projeto |
codFpj | Integer | Código da fase do projeto |
desFpj | String | Descrição da fase do projeto |
abrFpj | String | Abreviatura da fase do projeto |
claFpj | String | Classificação da fase do projeto |
datPif | DateTime | Data de previsão de início da fase do projeto |
datPff | DateTime | Data de previsão de finalização da fase do projeto |
datIfp | DateTime | Data do início da fase do projeto |
datFfp | DateTime | Data da finalização da fase do projeto |
perFpj | Double | Percentual de execução da fase do projeto |
obsFpj | String | Observação da fase do projeto |
nivFpj | Integer | Nível da fase |
posFpj | Integer | Quantidade de posições do nível da fase |
fpjPai | Integer | Código da fase pai |
anaSin | String | Indicativo se a fase é analítica ou sintética |
fpjNat | String | Natureza da fase |
aceRat | String | Indicativo se a fase aceita lançamento de rateio |
sitFpj | String | Indicativo da situação da fase do projeto |
codMot | Integer | Código do motivo da situação da fase do projeto |
obsMot | String | Observação do motivo da situação da fase do projeto |
codTns | String | Código da transação da fase |
tnsCan | String | Código da transação de cancelamento da fase |
tnsSup | String | Código da transação de suplementação da fase |
tnsDsp | String | Código da transação de desaprovação da fase |
ctaRed | Integer | Conta contábil reduzida - 1 |
ctaRcr | Integer | Conta contábil reduzida - 2 |
ctaFdv | Integer | Conta contábil reduzida - 3 |
ctaFcr | Integer | Conta contábil reduzida - 4 |
conApr | String | Considera orçamento para aprovação |
cadastroUsuario | Set | Passagem dos campos de usuário do cadastro de fase |
cadastroUsuario.nomCmp | String | Nome do campo de usuário |
cadastroUsuario.valCmp | String | Valor do campo de usuário |
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:CadFaseResponse> <result> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:CadFaseResponse> </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" |
resultado | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: Inclusão: "OK: Fase x cadastrada com sucesso!" Alteração: "OK: Fase x alterada com sucesso!" Execução do serviço com erros: "ERRO: mensagem do erro". |
CadFaseLote
Finanças - Gestão Orçamentária e Projetos - Controle Físico - Cadastro de Fases Lote
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:CadFaseLote> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <itensFases> <codFpj>Integer</codFpj> <desFpj>String</desFpj> <abrFpj>String</abrFpj> <claFpj>String</claFpj> <datPif>String</datPif> <datPff>String</datPff> <datIfp>String</datIfp> <datFfp>String</datFfp> <perFpj>Double</perFpj> <obsFpj>String</obsFpj> <nivFpj>Integer</nivFpj> <posFpj>Integer</posFpj> <fpjPai>Integer</fpjPai> <anaSin>String</anaSin> <fpjNat>String</fpjNat> <aceRat>String</aceRat> <sitFpj>String</sitFpj> <codMot>Integer</codMot> <obsMot>String</obsMot> <codTns>String</codTns> <tnsCan>String</tnsCan> <tnsSup>String</tnsSup> <tnsDsp>String</tnsDsp> <ctaRed>Integer</ctaRed> <ctaRcr>Integer</ctaRcr> <ctaFdv>Integer</ctaFdv> <ctaFcr>Integer</ctaFcr> <conApr>String</conApr> <cmpUsuFpj> <nomCmp>String</nomCmp> <valCmp>String</valCmp> </cmpUsuFpj> </itensFases> <codEmp>Integer</codEmp> <numPrj>Integer</numPrj> </parameters> </ser:CadFaseLote> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
itensFases | Set | Itens de produto |
itensFases.codFpj | Integer | Código da fase do projeto |
itensFases.desFpj | String | Descrição da fase do projeto |
itensFases.abrFpj | String | Abreviatura da fase do projeto |
itensFases.claFpj | String | Classificação da fase do projeto |
itensFases.datPif | DateTime | Data de previsão de início da fase do projeto |
itensFases.datPff | DateTime | Data de previsão de finalização da fase do projeto |
itensFases.datIfp | DateTime | Data do início da fase do projeto |
itensFases.datFfp | DateTime | Data da finalização da fase do projeto |
itensFases.perFpj | Double | Percentual de execução da fase do projeto |
itensFases.obsFpj | String | Observação da fase do projeto |
itensFases.nivFpj | Integer | Nível da fase |
itensFases.posFpj | Integer | Quantidade de posições do nível da fase |
itensFases.fpjPai | Integer | Código da fase pai |
itensFases.anaSin | String | Indicativo se a fase é analítica ou sintética |
itensFases.fpjNat | String | Natureza da fase |
itensFases.aceRat | String | Indicativo se a fase aceita lançamento de rateio |
itensFases.sitFpj | String | Indicativo da situação da fase do projeto |
itensFases.codMot | Integer | Código do motivo da situação da fase do projeto |
itensFases.obsMot | String | Observação do motivo da situação da fase do projeto |
itensFases.codTns | String | Código da transação da fase |
itensFases.tnsCan | String | Código da transação de cancelamento da fase |
itensFases.tnsSup | String | Código da transação de suplementação da fase |
itensFases.tnsDsp | String | Código da transação de desaprovação da fase |
itensFases.ctaRed | Integer | Conta contábil reduzida - 1 |
itensFases.ctaRcr | Integer | Conta contábil reduzida - 2 |
itensFases.ctaFdv | Integer | Conta contábil reduzida - 3 |
itensFases.ctaFcr | Integer | Conta contábil reduzida - 4 |
itensFases.conApr | String | Considera orçamento para aprovação |
itensFases.cmpUsuFpj | Set | Ligação do item com os campos de usuários |
itensFases.cmpUsuFpj.nomCmp | String | Nome do campo de usuário |
itensFases.cmpUsuFpj.valCmp | String | Valor do campo de usuário |
codEmp | Integer | Código da empresa do projeto |
numPrj | Integer | Número interno do projeto |
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:CadFaseLoteResponse> <result> <gridResult> <msgErr>String</msgErr> </gridResult> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:CadFaseLoteResponse> </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 erro |
gridResult.msgErr | String | Erros |
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. |