Skip to main content

Education Records Module

Record Modules#

In HRHIS there are three modules that mainly hold different types of records i.e. Employment records, Council records and Education Records.

Introduction#

What is record API?

A record API is the messenger that delivers a request to the provider from which it is being requested and then delivers the response(records) back.

What it generally offer

A record API contains HTTP status code and data returned.

Fetching#

Aggregate records Fetching data in record modules follow similar sequence of actions as described below.

Fetching listing records#

Method:

GET

A default endpoint for fetching

api/analytics/records/KwTlfYKlSCcEd?pageSize=50&page=1&ouMode=DESCENDANTS&listing=true

Where KwTlfYKlSCcEd is the form id

By default the page size is 50, but you can change the page size by setting the page size property to any number you wish.

You can also get all records for viewing without pagination by simply setting paging = 'false'.

ParameterDescriptionTypeNotes
PageSizeNumber of item per pagenumberby default it is 50
PagePage number (offset)number
Pagingspecifies whether to use paging or notwhen false (all records)are returned as response

Sample Data payload.

{
"pager": {
"page": 1,
"pageSize": 50,
"pageCount": 50,
"total": 1998,
"nextPage": "/api/analytics/records/KwTlfYKlSCcEd?page=2"
},
"records": [
{
"id": "q8dD4haVRtX9p",
"created": "2021-09-20T06:09:18.000Z",
"lastupdated": "2021-09-20T06:09:18.000Z",
"ou": {
"id": "Va5XqGVTyyZuK",
"created": "2021-05-14T18:36:40.000Z",
"lastUpdated": "2021-07-01T07:00:59.000Z",
"code": "15005214030201",
"name": "Kilosa Clinical Officers Training Centre",
"description": "Kilosa Clinical Officers Training Centre Full Accreditation",
"shortName": "Kilosa Cli",
"address": "Kilosa District Council",
"level": 4,
"path": "/52893cd1b8359/52f0a11563b5e/cRHIYtAEi2biB/Va5XqGVTyyZuK",
"ancestors": [
{
"id": "52893cd1b8359",
"created": "2013-11-17T19:01:53.000Z",
"lastUpdated": "2017-11-07T10:01:47.000Z",
"code": "MOHCDGEC",
"name": "Ministry Of Health",
"description": "Ministry of Health and Social welfare",
"shortName": "MOHCDGEC",
"active": true,
"level": 1,
"path": "/52893cd1b8359"
}
]
}
}
]
}

The fields in the responses are described below.

|Parameter|Type|Default|Description| |PageSize|Number|50|Number of items per page| |page|Number|1|Page number|| |paging|Boolean|true||Specify whether to do pagination or not

false: Fetch All record

true: Fetch record given pagination options

Searching parameters Dimension: <fields> Operators: <eq, !eq, in, !in>

OperatorDescription
eqFetch records where search item has EXACT MATCH for the given dimension
!eqFetch records where search item has NO MATCH for the given dimension
inFetch records with many search items where items exist IN records for the given dimension
!inFetch records with many search items where items do not exist IN records for the given dimension

|

Fetching a single record

You can also search for a single record as described below

Endpoint

/api/records/pbD8mdbEY8lLT?fields=id,organisationUnit[id,organisationUnitGroups],form,recordValues[field]

Specify field to get the record

Edit this page