Web service com.senior.g5.rh.fp.atendente
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/rubi_Synccom_senior_g5_rh_fp_atendente?wsdl
- Assíncrono: http://example.com/g5-senior-services/rubi_Asynccom_senior_g5_rh_fp_atendente?wsdl
- Agendado: http://example.com/g5-senior-services/rubi_Scheduledcom_senior_g5_rh_fp_atendente?wsdl
Porta
IntegraAtendente
Web service de integração que permite cadastrar, alterar e excluir atendentes.
Disponível nos módulos SM e AP.
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:IntegraAtendente> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <tipOpe>String</tipOpe> <conAso>String</conAso> <codAte>Integer</codAte> <endRua>String</endRua> <oriAte>String</oriAte> <endNum>String</endNum> <numEmp>Integer</numEmp> <endCpl>String</endCpl> <tipCol>Integer</tipCol> <codCid>Integer</codCid> <numCad>Integer</numCad> <codBai>Integer</codBai> <nomAte>String</nomAte> <endCep>String</endCep> <codPrf>Integer</codPrf> <ddiCon>Integer</ddiCon> <regCon>String</regCon> <dddCon>Integer</dddCon> <sitReg>String</sitReg> <telCon>String</telCon> <titAte>String</titAte> <cplCon>String</cplCon> <ddiTel>Integer</ddiTel> <dddTel>Integer</dddTel> <numTel>String</numTel> <codUsu>Integer</codUsu> <codPos>Integer</codPos> <qtdMes>Integer</qtdMes> <indPar>String</indPar> <fecQue>String</fecQue> <conCid>Integer</conCid> </parameters> </ser:IntegraAtendente> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
tipOpe | Obrigatório | String | Tipo da operação a ser efetuada na integração.
I - Inclusão A - Alteração E - Exclusão |
conAso | Opcional | String | Define qual endereço de contato deve sair no ASO/Audiometria. N - Não emite E - Emite Endereço C - Emite Contato Esse parâmetro deve ser preenchido apenas no módulo SM. |
codAte | Opcional | Integer | Indicar um número de cadastro do atendente.
- Chave Observações: - Na alteração e exclusão o código é obrigatório. - Na inclusão, se deixar o campo vazio ou com zero, o sistema irá incluir o atendente com o próximo código de atendente disponível. |
endRua | Opcional | String | Endereço para contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
oriAte | Opcional | String | Indicar a origem do atendente:
E - Externo I - Interno |
endNum | Opcional | String | Número do endereço de contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
numEmp | Opcional | Integer | Indicar o código da empresa do colaborador ligado ao atendente.
Observação: - Este campo somente pode e deve ser informado quando a origem do atendente for "Interno". |
endCpl | Opcional | String | Complemento do endereço de contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
tipCol | Opcional | Integer | Indicar o tipo do colaborador ligado ao atendente.
1 - Empresa 2 - Terceiro 3 - Parceiro Observação: - Este campo somente pode e deve ser informado quando a origem do atendente for "Interno". |
codCid | Opcional | Integer |
Código da cidade. Esse parâmetro deve ser preenchido apenas no módulo SM. |
numCad | Opcional | Integer | Indicar o colaborador ligado ao atendente.
Observação: - Este campo somente pode e deve ser informado quando a origem do atendente for "Interno". |
codBai | Opcional | Integer | Código do bairro.
Esse parâmetro deve ser preenchido apenas no módulo SM. |
nomAte | Opcional | String | Indicar o nome do atendente.
Observações: - Quando a situação do atendente for "Externo" é obrigatório informar este campo. - Quando a situação do atendente for "Interno" não pode ser informado este campo. |
endCep | Opcional | String | Código do CEP do endereço de contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
codPrf | Opcional | Integer | Indicar o conselho profissional no qual o atendente pertence.
|
ddiCon | Opcional | Integer | Código DDI do contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
regCon | Opcional | String | Indicar o número de registro do conselho.
|
dddCon | Opcional | Integer | Código DDD do contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
sitReg | Opcional | String | Indicar a situação do registro profissional do atendente.
D - Definitivo P - Provisório |
telCon | Opcional | String | Número do telefone para contato. Esse parâmetro deve ser preenchido apenas no módulo SM. |
titAte | Opcional | String | Indicar o título do atendente.
Obs: No módulo Administração de Pessoal este campo não está disponível. |
cplCon | Opcional | String | Contato para constar na emissão do ASO. Esse parâmetro deve ser preenchido apenas no módulo SM. |
ddiTel | Opcional | Integer | Indicar o DDI do telefone do atendente.
|
dddTel | Opcional | Integer | Indicar o DDD do telefone do atendente.
|
numTel | Opcional | String | Indicar o número do telefone do atendente.
|
codUsu | Opcional | Integer | Indicar o código do usuário associado ao atendente.
Observação: - Somente pode ser informado, caso a origem do atendente for "Interno". |
codPos | Opcional | Integer | Indicar o código do posto de atendimento no qual o atendente geralmente trabalha.
Obs: No módulo Administração de Pessoal este campo não está disponível. |
qtdMes | Opcional | Integer | Indicar o tempo que será retrocedido para considerar exames no ASO.
Obs: No módulo Administração de Pessoal este campo não está disponível. |
indPar | Opcional | String | Indicar a situação do exame que será considera na emissão do ASO.
S - Sem parecer C - Com parecer A - Ambos Obs: No módulo Administração de Pessoal este campo não está disponível. |
fecQue | Opcional | String | Indicar o comportamento ao gravar as respostas do questionário.
F - Fechar ao gravar N - Não fechar automaticamente (no módulo SM) Obs: No módulo Administração de Pessoal este campo não está disponível. |
conCid | Opcional | Integer | Indicar como deve apresentar a tela de consulta de CID.
0 - Árvore 1 - Tela de consulta padrão Obs: No módulo Administração de Pessoal este campo não está disponível. |
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:IntegraAtendenteResponse>
<result>
<erroExecucao>String</erroExecucao>
</result>
</ser:IntegraAtendenteResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
erroExecucao | Opcional | 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 sucesso; - A mensagem do erro ocorrido no servidor. |