Synergetic.Api 0.0.1-alpha

Synergetic.API

A .NET Core, Standard and Framework async implementation of the Synergetic API. The API has been developed against the API at Synergetic version 70.16.1.

This is an unoffical library.

Synergetic API developer documentation can be found at https://developer.synergetic.net.au/

Note: Only GET requests have been tested so far

Usage

Initialisation

Before you can use the Synergetic API client, you first need to configure it in your application. This only has to be done once.

Automatically acquiring a token

By default, the API client to automatically acquires the token if it has not previously been acquired, or has expired. For a web application, call the following code in Startup.cs

SynergeticClient.Initialise("{ClientId}", "{ClientSecret}", "{SynergeticAPIUrl}"); 

You do not need to call the AcquireToken method (below) when doing this.

Manually acquiring a token

There may be times where you want to control the timing of the extra network call when acquiring a token. By default, the API client automatically acquires a token, or refreshes it if it has expired. To change this behaviour, set automaticallyAcquireToken to 'false'.

For a web application, call the following code in Startup.cs

SynergeticClient.Initialise("{ClientId}", "{ClientSecret}", "{SynergeticAPIUrl}", automaticallyAcquireToken: false); 

Next acquire a token to use for subsiquent API calls

SynergeticClient.AcquireToken(); 

Using the API

Once you have initialised the client, you can query the Synergetic API by creating an instance of the appropiate service and using the Get/Create/Update methods.

Current services available are:

• LookupTableService
• StudentService
• StudentAllergyService
• StudentContactsService
• StudentResultsService
• MedicalConditionsService
• MedicalDetailsService
• MedicalImmunisationsService

Querying the API

using Synergetic.Api.Services.Students;

var studentService = new StudentService();
var students = studentService.Get();

Updating or Creating Records

NOTE: These methods are untested

Following the Synergetic API spec, a list of new items, or items to update can be posted to the API.

using Synergetic.Api.Services.StudentAllergies;

var studentAllergyService = new StudentAllergyService();

var allergies = new List<CreateStudentAllergyRequest>(){ ... }

var results = studentService.Create(allergies);

The API wrapper also allows only one item to be create/updated:

using Synergetic.Api.Services.StudentAllergies;

var studentAllergyService = new StudentAllergyService();

var allergy = new CreateStudentAllergyRequest(){ ... }

var result = studentService.Create(allergy);

These methods will return a list of EntityResult object if more than one object is passed, or a single EntityResult if only one object is passed.