URL

URL_INSTALL/system/service/process

Método

POST

Formato de dados

JSON

Parâmetros básicos

Todas as requisições devem ter os três parâmetros, especificados a seguir:

{"_service": "xxx","_function": "xxx","_stoken": "xxx"}

As requisições de consulta de relatório, além dos parâmetros acima, deve adicionar novos parâmetros obrigatórios:

 {"_dkey": "xxx","_key": "xxx"}

Os relatórios que processam serviços externo como no caso do módulo MReport que processa consulta na base de dados externo do Moodle deve adicionar novos parâmetros obrigatórios além dos já mencionados acima:

{"parentid": "xxx","_serviceid": "xxx","_datasource": "xxx"}

Parâmetro

Descrição

_service

Endereço de serviço a ser acionado. Cada serviço é
uma classe no sistema Badiu.Net.

Em caso de consulta de relatório, o valor padrão é:

badiu.system.core.functionality.factoryreportwebservice 

_function

Função a ser acionado na classe. Se o parâmetro não for definido o sistema usa a função exec como padrão. 

Em caso de consulta de relatório,  não precisa definir a função. 

_stoken

Token de autenticação

Parâmetro

Descrição

_dkey

Define a chave da classe sobre o tipo de relatório que irá ser processado. É um parâmetro obrigatório. 

Deve receber os seguintes valores:

badiu.system.core.report.dynamic.index
Para relatórios padrão sem chave pai (parâmetro parentid)

badiu.system.core.report.dynamicp.index
Para relatórios padrão que exige chav pai (parâmetro parentid)

badiu.system.core.report.dynamicd.dashboard
Para relatórios dashboard sem chave pai (parâmetro parentid)

badiu.system.core.report.dynamicdp.dashboard
Para relatórios dashboard que exige chav pai (parâmetro parentid)

_key

Chave única de identificação da cada relatório. 

 É um parâmetro obrigatório. 

parentid

Parâmetro de identificação do elemento pai do relatório que está sendo gerado. Trata-se de registros que devem ser filtrados com base numa chave de filtro básico. 

_serviceid

Traservicesqlta-se da identificação do serviço externo a ser consultado. O módulo MReport faz consulta em Moodle externo. Cada Plataforma Moodle tem um id de identificação. 

Esse parâmetro é obrigatório em caso de consulta de relatórios do MReport

_datasource

Trata-se de método de conexão  para cada fonte de dados. Recebe dois valores: 

- dbdoctrine - Consulta realizada pelo API do badiunet na base local

- servicesql - Para consulta usando serviço SQL. Isso é usado para fonte externa no caso das consultas realizadas pelo MReport

dbdoctrine é o valor padrão, caso não for definido. Para consultas que envolvem o módulo MReport o valor deve ser servicesql.

_freportid

Esse parâmetro é usado para os relatórios gerados de forma dinâmica pelo módulo SyncFreport