Stat HTTP REST API

Stat

Get IPEHR statistics total

GET /

Description:

Retrieve the IPEHR statistics total and current month

Responses

Code	Description	Schema
200	OK	stat.ResponseTotal
500	Is returned when an unexpected error occurs while processing a request

Get IPEHR statistics per month

GET /{period}

Description:

Retrieve the IPEHR statistics per month

Parameters

Name	Located in	Description	Required	Schema
period	path	Month in YYYYYMM format. Example: 202201	No	string

Responses

Code	Description	Schema
200	OK	stat.ResponsePeriod
500	Is returned when an unexpected error occurs while processing a request

Query

Execute AQL query

POST /query/

Description:

Performs processing of incoming AQL requests.

Parameters

Name	Located in	Description	Required	Schema
Request	body	Query request	Yes	model.QueryRequest

Responses

Code	Description	Schema
200	Indicates that the request has succeeded and transaction about register new user has been created	model.QueryResponse
400	The request could not be understood by the server due to incorrect syntax.
408	The request was canceled due to exceeding the waiting limit.
500	Is returned when an unexpected error occurs while processing a request

Models

model.QueryColumn

Name	Type	Description	Required
name	string		No
path	string		No

model.QueryRequest

Name	Type	Description	Required
ehr_id	string		No
fetch	integer		No
offset	integer		No
q	string		No
query_parameters	object		No

model.QueryResponse

Name	Type	Description	Required
columns	model.QueryColumn		No
meta	object		No
name	string		No
q	string		No
rows	[ ]		No

stat.ResponsePeriod

Name	Type	Description	Required
data	stat.Stat		No
type	string		No

stat.ResponseTotal

Name	Type	Description	Required
data	stat.Stat		No
month	stat.Stat		No
type	string		No

stat.Stat

Name	Type	Description	Required
documents	integer		No
patients	integer		No
time	integer		No