das-courses-api

Requirements

• .net6 and any supported IDE for DEV running.
• If you are not wishing to run the in memory database then
• SQL Server database.
• Azure Storage Account

About

das-courses-api represents the inner api definition for apprenticeship standards, with data taken from IFATE and LARS. The API creates a local copy of the data for querying over. The API also runs a RAM version of Lucene, to allow keyword searching of courses by Title, Keyword and Typical Job Titles.

Local running

In memory database

It is possible to run the whole of the API using the InMemory database. To do this the environment variable in appsettings.json should be set to DEV. Once done, start the application as normal, then run the ops/dataload operation in swagger. You will then be able to query the API as per the operations listed in swagger.

SQL Server database

You are able to run the API by doing the following:

• Run the database deployment publish command to create the database SFA.DAS.Courses or create the database manually and run in the table creation scripts
• In your Azure Storage Account, create a table called Configuration and Add the following

ParitionKey: LOCAL
RowKey: SFA.DAS.Courses.Api_1.0
Data: {"Courses":{"ConnectionString":"DBCONNECTIONSTRING"}}

• Start the api project SFA.DAS.Courses.Api

Once started, select the Operations V1 defintion in swagger, and execute the following endpoint

POST /ops/dataload

This will load data from IFATE, LARS and a static Frameworks data file, into the local database.

Switching back to the CoursesApi defintion will then allow you to exectue the other endpoints. Note that if you are running using InMemory then you will need to load the data on each run.