N2C.VismaNET.HttpBase 1.0.4

Http Base

This is a base class for Http requests. It is used by the other Http classes. You need to inherit from this class to be able to use the other classes.

Getting Started

You need to have a valid token to be able to use the API. You can get a token by using the Visma.net API Authentication. You can use the N2C.VismaNET.Token package.

Usage

You need to inherit from this class to be able to use the other classes.

Here is an example of how to implement the ApiBase class in the Get class.

/// <summary>
/// Get is a class for getting employees from the Visma.net API.   
/// </summary>
public class Get : ApiBase
{
    /// <summary>
    /// Get is the constructor for the Get class. 
    /// </summary>
    /// <param name="bearerToken">
    /// BearerToken is the bearer token for the Visma.net API. 
    /// </param>
    /// <param name="tenantId">
    /// TenantId is the tenant id for the Visma.net API.
    /// </param>
    public Get(string bearerToken, string tenantId) : base(bearerToken, tenantId)
    {
        this.Controller = "employee";
    }
    /// <summary>
    /// GetEmployeesAsync gets all employees from the Visma.net API. 
    /// </summary>
    /// <returns></returns>
    public async Task<IEnumerable<DTOs.Employee>> GetEmployeesAsync()
    {
        try
        {
            var response = await GetAsync<IEnumerable<DTOs.Employee>>(Controller);
            return response;
        }
        catch (Exception e)
        {
            Debug.WriteLine(e.Message);
            throw;
        }
    }
    
    /// <summary>
    /// GetEmployeeAsync gets a single employee from the Visma.net API. 
    /// </summary>
    /// <param name="employeeNumber">
    /// EmployeeNumber is the employee number for the employee to get from the Visma.net API. 
    /// </param>
    /// <returns>
    /// Returns a single employee from the Visma.net API. 
    /// </returns>
    public async Task<DTOs.Employee> GetEmployeeAsync(string employeeNumber)
    {
        var response = await GetAsync<DTOs.Employee>($"{Controller}/{employeeNumber}");
        return response;
    }
}

Version

1.0.4

• Added better error handling for all methods.
• Added xml comment and documentation for all methods.