| Builds | Branch | Status |
|---|---|---|
| Circle CI | main |  |
| SonarCloud | main |
Api to provide details of institutions and schools in Northern Ireland
You will need to contact the team to get an api key and secret to allow your application to consume this api.
Contributions are welcomed! Read the Contributing Guide for more information.
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.
We built this api so many applications and users can have access to a list of schools and institutions in Northern Ireland.
This solves having to create a school table in every single application and adding the same code over and over again.
This is a dotnet core application which uses Mysql to store the school data, Entity Framework for data access and JWT to authenticate applications to allow them to use the api. We have hosted this in the Gov UK PaaS Cloud foundry platform using Circle CI to deploy. This uses Swagger as a handy UI.
We may introduce a more advanced search if needed.
To run the databases you need mysql installed. Then run the below commands to set up the database:
- update-database
Restore the nuget package. Then to build run "dotnet build" in command line then dotnet run to run the site.
GETS
/api/v1/Institution/GetAll - This gets all the institutions by using paging so you can select how many pages and per page you want
/api/v1/Institution/GetByReferenceNumber - Gets institution by its reference number
/api/v1/Institution/SearchByName - Gets Institution by name
/api/v1/Institution/SearchSchoolByName - Gets School (primary, post primary, grammar etc) by name
/api/v1/Institution/GetSchoolByReferenceNumber - Gets school (primary, post primary, grammar etc) by reference number
POST - TBA
PUT - TBA
DELETE - TBA