Web service com.senior.g5.rh.hr.persistencia
Serviço para incluir, alterar e excluir registros na base do Gestão de Pessoas | HCM.
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 identificado o tipo no parâmetro <encryption>, conforme seus valores possíveis.
WSDL
- Síncrono: http://example.com/g5-senior-services/ronda_Synccom_senior_g5_rh_hr_persistencia?wsdl
- Assíncrono: http://example.com/g5-senior-services/ronda_Asynccom_senior_g5_rh_hr_persistencia?wsdl
- Agendado: http://example.com/g5-senior-services/ronda_Schedulecom_senior_g5_rh_hr_persistencia?wsdl
Porta(s)
Afastamentos
Permite inserir, alterar ou excluir históricos de afastamentos.
Necessita autenticação: Sim.
Situação da 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:Afastamentos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> </campo> </registro> </parameters> </ser:Afastamentos> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir IA = Incluir/Alterar |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo | Set | Obrigatório | Campos da tabela R038AFA que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
Observação: O separador de números decimais é o ponto. Exemplo: 9.99. Campos de usuário também são permitidos. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo.nome | String | Obrigatório | Nome do campo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY Números com decimais: 9.99 |
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:AfastamentosResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campo> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> </registro> </result> </ser:AfastamentosResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK / 1: Consistência de negócio / 2: Consistência customizados / 3: Erro nos campos / 4: Erro não mapeado / 5: Registro inexistente / 6: Parâmetro inválido / 7: Aviso / 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK / 1: Consistência de negócio / 2: Consistência customizados / 3: Erro nos campos / 4: Erro não mapeado / 5: Registro inexistente / 6: Parâmetro inválido / 7: Aviso / 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |
Atendentes
Permite inserir, alterar ou excluir cadastros de Atendentes.
Necessita autenticação: Sim.
Situação da 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:Atendentes> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> </campo> </registro> </parameters> </ser:Atendentes> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo | Set | Obrigatório | Campos da tabela R108TAT que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
Observação: O separador de números decimais é o ponto. Exemplo: 9.99. Campos de usuário também são permitidos. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo.nome | String | Obrigatório | Nome do campo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY. Números com decimais: 9.99 |
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:AtendentesResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campo> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> </registro> </result> </ser:AtendentesResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK / 1: Consistência de negócio / 2: Consistência customizados / 3: Erro nos campos / 4: Erro não mapeado / 5: Registro inexistente / 6: Parâmetro inválido / 7: Aviso / 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK / 1: Consistência de negócio / 2: Consistência customizados / 3: Erro nos campos / 4: Erro não mapeado / 5: Registro inexistente / 6: Parâmetro inválido / 7: Aviso / 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |
CentrosDeCustos
Possibilita inserir, alterar ou excluir Centros de Custos.
Necessita autenticação: Sim.
Situação da 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:CentroDeCustos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> </campo> </registro> </parameters> </ser:CentroDeCustos> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo | Set | Obrigatório | Campos da tabela R018CCU que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
Observações: - O separador de números decimais é o ponto. Exemplo: 9.99. - Campos de usuário também são permitidos. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo.nome | String | Obrigatório | Nome do campo. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY. Números com decimais: 9.99 |
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:CentroDeCustosResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campo> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> </registro> </result> </ser:CentroDeCustosResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |
HistoricoCentroDeCusto
Possibilita inserir, alterar ou excluir Históricos de Centro de Custo.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
<soapenv:Envelope xmlns:ser="http://services.senior.com.br" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ser:HistoricoCentroDeCusto> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> </parameters> </ser:HistoricoCentroDeCusto> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir |
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. |
campo | Set | Obrigatório | Campos da tabela R038HCC que serão utilizados na operação. Cada ocorrência deste elemento representa um campo. (Substituir pela Tabela 1) Observações: - O separador de números decimais é o ponto. Exemplo: 9.99. - Campos de usuário também são permitidos. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY. Números com decimais: 9.99 |
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:ser="http://services.senior.com.br" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ser:HistoricoCentroDeCustoResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> </result> </ser:HistoricoCentroDeCustoResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |
OutrasEmpresas
Possibilita inserir, alterar ou excluir Outras Empresas.
Necessita autenticação: Sim.
Situação da 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:OutrasEmpresas> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> </campo> </registro> </parameters> </ser:OutrasEmpresas> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir |
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. |
campo | Set | Obrigatório | Campos da tabela R032OEM que serão utilizados na operação. Cada ocorrência deste elemento representa um campo. (Substituir pela Tabela 1) Observações: - O separador de números decimais é o ponto. Exemplo: 9.99. - Campos de usuário também são permitidos. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY. Números com decimais: 9.99 |
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:OutrasEmpresasResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campo> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> </registro> </result> </ser:OutrasEmpresasResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |
Rateios
Possibilita inserir, alterar ou excluir Rateios.
Necessita autenticação: Sim.
Situação da 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:Rateios> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> </campo> </registro> </parameters> </ser:Rateios> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir |
||||||||||||||||||||||||
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. | ||||||||||||||||||||||||
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. | ||||||||||||||||||||||||
campo | Set | Obrigatório | Campos da tabela R020RAT que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
Observações: - O separador de números decimais é o ponto. Exemplo: 9.99. - Campos de usuário também são permitidos. |
||||||||||||||||||||||||
campo.nome | String | Obrigatório | Nome do campo. | ||||||||||||||||||||||||
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY. Números com decimais: 9.99 |
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:RateiosResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campo> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> </registro> </result> </ser:RateiosResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |
RateioTomador
Possibilita inserir ou alterar Tomadores por Rateio.
Necessita autenticação: Sim.
Situação da 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:RateioTomador> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <operacao>String</operacao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> </campo> </registro> </parameters> </ser:RateioTomador> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Preenchimento | Descrição | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
operação | String | Obrigatório | I = Inserir A = Alterar E = Excluir |
||||||||||||||||||||||||||||||
registro | Set | Obrigatório | Cada ocorrência deste elemento representa uma operação a ser executada pelo sistema. | ||||||||||||||||||||||||||||||
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. Deve ser informada pelo solicitante. | ||||||||||||||||||||||||||||||
campo | Set | Obrigatório | Campos da tabela R020TOM que serão utilizados na operação. Cada ocorrência deste elemento representa um campo.
Observações: - O separador de números decimais é o ponto. Exemplo: 9.99. - Campos de usuário também são permitidos. |
||||||||||||||||||||||||||||||
campo.nome | String | Obrigatório | Nome do campo. | ||||||||||||||||||||||||||||||
campo.valor | String | Obrigatório | Valor referente ao campo informado. Para alguns tipos de dados, é necessário seguir a seguinte formatação: Data: DD/MM/YYYY. Números com decimais: 9.99 |
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:RateioTomadorResponse> <result> <erroAposExecucao>String</erroAposExecucao> <erroExecucao>String</erroExecucao> <registro> <sequencia>Integer</sequencia> <campo> <nome>String</nome> <valor>String</valor> <status>Integer</status> <mensagem>String</mensagem> </campo> <status> <codigo>String</codigo> <mensagem>String</mensagem> </status> </registro> </result> </ser:RateioTomadorResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Tipo | Preenchimento | Descrição |
---|---|---|---|
registro | Set | Obrigatório | Repete as operações enviadas na requisição, com o retorno para cada uma. Cada ocorrência deste elemento representa uma operação. |
registro.sequencia | Integer | Obrigatório | Identificador para facilitar a recuperação do resultado. |
campo | Set | Obrigatório | Repete os campos enviados na requisição, com um retorno para cada um. Cada ocorrência deste elemento representa um campo. |
campo.nome | String | Obrigatório | Nome do campo. |
campo.valor | String | Obrigatório | Valor referente ao campo informado. |
campo.status | Integer | Obrigatório | Status do retorno da requisição ao webservice. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
campo.mensagem | String | Obrigatório | Mensagem de consistência do campo. Se o valor estiver consistente retornará OK. Caso o contrário, retornará a mensagem de erro. |
status | Set | Obrigatório | Mensagens de retorno da operação. Cada ocorrência deste elemento representa uma mensagem de retorno. |
status.codigo | Integer | Obrigatório | Código da mensagem. 0: OK 1: Consistência de negócio 2: Consistência customizados 3: Erro nos campos 4: Erro não mapeado 5: Registro inexistente 6: Parâmetro inválido 7: Aviso 8: Registro já cadastrado |
status.mensagem | Integer | Obrigatório | Mensagem de retorno da operação. Se a operação for executada corretamente retornará OK. Caso o contrário, retornará a mensagem de erro. |