Ers.ApiClient 1.2.1-rc

Ers.Apiclient

A simple .NET client for the European Respiratory Society REST API.

ErsApiClient class

Provides wrapping methods around ERS API endpoints.

Constructor

Instantiation of the ErsApiClient class requires ERS API credentials (username + password), which will be used internally to request a OAuth 2 JWT token.

Optionally a URI of the ERS API base address can also be provided, typically to target the development API instead of the production API.

ErsApiClient client = new ErsApiClient("api username", "api password");
// Or
ErsApiClient devClient = new ErsApiClient("api username", "api password", "https://crmapitest.ersnet.org/");

GetAuthorizedPropertiesAsync

Returns contact properties that are authorized for the current API caller.

string[] properties = await client.GetAuthorizedPropertiesAsync();

AuthenticateAsync

Authenticates the specified contact's credentials and returns properties of the authenticated contact, if found.

If no contact matches the provided credentials, the method returns null.

The third argument 'includedProperties' accepts an optional comma separated list of properties to be returned in the response. If the parameter is omitted, only the ContactId property of the authenticated contact is returned.

This overload returns a JSON string.

var json = await client.AuthenticateAsync("contact username", "contact password", "Title,LastName,FirstName,SmtpAddress1");

AuthenticateAsync<T>

Authenticates the specified contact's credentials and returns properties of the authenticated contact, if found.

This overload converts the JSON result to the type T, assuming the respone can be converted to this type.

var contact = await client.AuthenticateAsync<Ers.ApiClient.Models.Contact>("contact username", "contact password", "Title,LastName,FirstName,SmtpAddress1");

AuthenticateEmailAsync

Authenticates the specified contact's SMTP address and returns properties of the authenticated contact, if found.

If no contact matches the provided SMTP address, the method returns null.

If more than one contact match the provided SMTP address, a NotSupportedException is thrown.

The third argument 'includedProperties' accepts an optional comma separated list of properties to be returned in the response. If the parameter is omitted, only the ContactId property of the authenticated contact is returned.

This overload returns a JSON string.

var json = await client.AuthenticateAsync("contact username", "contact password", "Title,LastName,FirstName,MainCity,MainCountryCode");

AuthenticateEmailAsync<T>

Authenticates the specified contact's SMTP address and returns properties of the authenticated contact, if found.

This overload converts the JSON result to the type T, assuming the respone can be converted to this type.

var contact = await client.AuthenticateAsync<Ers.ApiClient.Models.Contact>("contact username", "contact password", "Title,LastName,FirstName,MainCity,MainCountryCode");

Ers.ApiClient.Models.Contact class

This is a simple ERS API contact Data Transfer Object class that can be used as a type parameter for the ErsApiClient.AuthenticateAsync<T> generic method.