Ronda Senior - Manual do Usuário > Integrações com outros sistemas > Web services > Web services disponíveis > Web services da Concentradora e CSM Center > CSMCenterAdm

Web service CSMCenterAdm

Fornece operações administrativas para gerenciar aplicativos na CSM Center.

Tipo de execução

Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.

WSDL

Detalhes do WSDL:

URL do WSDL: http://servidor:8585/csm-center-ejb/CsmCenterAdmService/CsmCenterAdm?wsdl
Namespace: http://webservice.csmcenter.seguranca.senior.com/
Service Name: CsmCenterAdmService
Port Name: CsmCenterAdm
Binding: SOAP 1.1 (RPC/Literal)

Operações disponíveis:

obtemInformacao: Obtém informações sobre um aplicativo;
iniciaAplicacao: Inicia um aplicativo;
pausaAplicacao: Para/pausa um aplicativo.

Acesso ao WSDL:

curl "http://localhost:8585/csm-center-ejb/CsmCenterAdmService/CsmCenterAdm?wsdl"

obtemInformacao

Obtém informações sobre um aplicativo específico da CSM Center, verificando se está em execução.

Operação SOAP:

obtemInformacao

Necessita autenticação: Não. Aceita usuário como parâmetro mas não valida autenticação ativamente. É usado para logs de auditoria.

Parâmetros:

Nome	Preenchimento	Tipo	Descrição
aplicacao	Obrigatório	String	Código do aplicativo a consultar. Os valores aceitáveis para este campo são: CMarSv - Coletor de Marcações; CAlmSv - Coletor de Alarmes; SpGerCmd - Gerenciador de Comandos.

SOAP Request (Envelope):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.csmcenter.seguranca.senior.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:obtemInformacao>
      <aplicacao>CMarSv</aplicacao>
    </web:obtemInformacao>
  </soapenv:Body>
</soapenv:Envelope>

SOAP Response (Envelope):

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.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns1:obtemInformacaoResponse xmlns:ns1="http://webservice.csmcenter.seguranca.senior.com/">
      <return>
        <codRetorno>0</codRetorno>
        <mensagemRetorno>Sucesso ao recuperar informações do aplicativo: CMarSv!</mensagemRetorno>
        <stringConexao>sa@framework1</stringConexao>
        <intervaloExecucao>60</intervaloExecucao>
        <emExecucao>sim</emExecucao>
        <registrosLidos>0</registrosLidos>
        <registrosProcessados>0</registrosProcessados>
        <registrosRejeitados>0</registrosRejeitados>
      </return>
    </ns1:obtemInformacaoResponse>
  </soap:Body>
</soap:Envelope>

Atributos da resposta:

Nome	Preenchimento	Tipo	Descrição
codRetorno	Obrigatório	Integer	Código de retorno da operação. Os valores possíveis são: 0: sucesso; 1: erro.
mensagemRetorno	Obrigatório	String	Mensagem descritiva do resultado da operação.
stringConexao	Obrigatório	String	String de conexão com o banco de dados.
intervaloExecucao	Obrigatório	Integer	Intervalo de tempo em segundos entre execuções do timer/aplicativo.
emExecucao	Obrigatório	String	Indica se o aplicativo está em execução. Os valores possíveis são "sim" e "nao".
registrosLidos	Obrigatório	Integer	Quantidade de registros/eventos recebidos pelo aplicativo.
registrosProcessados	Obrigatório	Integer	Quantidade de registros/eventos processados com sucesso.
registrosRejeitados	Obrigatório	Integer	Quantidade de registros/eventos rejeitados (com erro).

iniciaAplicacao

Inicia um aplicativo específico da CSM Center. Esta operação registra a ação no log de auditoria de atividades do usuário.

Operação SOAP:

iniciaAplicacao

Necessita autenticação: Não. Aceita usuário como parâmetro mas não valida autenticação ativamente. É usado para logs de auditoria.

Parâmetros:

Nome	Preenchimento	Tipo	Descrição
aplicacao	Obrigatório	String	Código do aplicativo a iniciar. Os valores aceitáveis para este campo são: CMarSv - Coletor de Marcações; CAlmSv - Coletor de Alarmes; SpGerCmd - Gerenciador de Comandos.
username	Obrigatório	String	Nome do usuário executando a operação, para auditoria.

SOAP Request (Envelope):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.csmcenter.seguranca.senior.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:iniciaAplicacao>
      <aplicacao>CMarSv</aplicacao>
      <username>senior</username>
    </web:iniciaAplicacao>
  </soapenv:Body>
</soapenv:Envelope>

SOAP Response (Sucesso):

Observação

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns1:iniciaAplicacaoResponse xmlns:ns1="http://webservice.csmcenter.seguranca.senior.com/">
      <return>
        <codRetorno>0</codRetorno>
        <mensagemRetorno>Aplicativo: CMarSv. Em execucao!</mensagemRetorno>
      </return>
    </ns1:iniciaAplicacaoResponse>
  </soap:Body>
</soap:Envelope>

SOAP Response (Já em execução):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns1:iniciaAplicacaoResponse xmlns:ns1="http://webservice.csmcenter.seguranca.senior.com/">
      <return>
        <codRetorno>1</codRetorno>
        <mensagemRetorno>Aplicativo: CMarSv. Já está em execucao!</mensagemRetorno>
      </return>
    </ns1:iniciaAplicacaoResponse>
  </soap:Body>
</soap:Envelope>

Exemplo curl (SOAP):

curl -X POST "http://localhost:8585/csm-center-ejb/CsmCenterAdmService/CsmCenterAdm" \
 -H "Content-Type: text/xml; charset=utf-8" \
 -H "SOAPAction: " \
 -d '<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.csmcenter.seguranca.senior.com/">
<soapenv:Header/>
<soapenv:Body>
<web:iniciaAplicacao>
<aplicacao>CMarSv</aplicacao>
<username>admin</username>
</web:iniciaAplicacao>
</soapenv:Body>
</soapenv:Envelope>'

pausaAplicacao

Para/pausa um aplicativo específico da CSM Center. Esta operação registra a ação no log de auditoria de atividades do usuário.

Operação SOAP:

pausaAplicacao

Necessita autenticação: Não. Aceita usuário como parâmetro mas não valida autenticação ativamente. É usado para logs de auditoria.

Parâmetros:

Nome	Preenchimento	Tipo	Descrição
aplicacao	Obrigatório	String	Código do aplicativo a parar. Os valores aceitáveis para este campo são: CMarSv - Coletor de Marcações; CAlmSv - Coletor de Alarmes; SpGerCmd - Gerenciador de Comandos.
username	Obrigatório	String	Nome do usuário executando a operação, para auditoria.

SOAP Request (Envelope):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice.csmcenter.seguranca.senior.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:pausaAplicacao>
      <aplicacao>CMarSv</aplicacao>
      <username>senior</username>
    </web:pausaAplicacao>
  </soapenv:Body>
</soapenv:Envelope>

SOAP Response (Sucesso):

Observação

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns1:pausaAplicacaoResponse xmlns:ns1="http://webservice.csmcenter.seguranca.senior.com/">
      <return>
        <codRetorno>0</codRetorno>
        <mensagemRetorno>Aplicativo: CMarSv. Em pausa!</mensagemRetorno>
      </return>
    </ns1:pausaAplicacaoResponse>
  </soap:Body>
</soap:Envelope>

PORTAL DE DOCUMENTAÇÃO
Ronda Senior - versão 6.10.4