Introduction
The following code creates a single new user on the platform with the following details
| Parameter | Description |
|---|---|
| Employee groups | Optional comma separated list of employee groups defined for this tenant. If used this must reference employee group names exactly |
| Title | Optional, currently limited to Mr, Miss, Ms, Mrs, Mstr, Dr or blank. NOTE: no full stops after the title! |
| Forename | Optional string |
| Surname | Optional string |
| Second Surname | Optional string |
| Date of Birth | Optional UK Date Format |
| Gender | Optional Male, Female or Unspecified |
| REQUIRED must be a valid distinct email. Email address cannot be repeated for multiple users as it forms an essential identifier for the account | |
| Address line 1 | Optional string |
| Address line 2 | Optional string |
| Address line 3 | Optional string |
| Town | Optional string |
| County | Optional string |
| Post Code | Optional string in Post Code format |
| Start date | Optional Date format |
| NINO | Optional string in National Insurance format |
| Cost centre | Optional should match exactly the name of an existing cost centre on the company record. |
| Payroll number | Optional string, should be distinct within this tenant |
| Salary | Optional decimal |
| Preferred name | Optional string |
| Metadata 1 | |
| Metadata 2 | |
| Benefit Package |
Fail events
- User with same email address exists
Authentication
See MyWorkPal Open API for instructions
Example
You can now use this admin account to access the API endpoint with the example code below.
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
namespace ConsoleApp1
{
class Program
{
static async Task Main(string[] args)
{
try
{
await ConnectApi();
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
}
private class IdpResponse
{
public string access_token { get; set; }
public int expires_in { get; set; }
public string token_type { get; set; }
}
private class ReportLine
{
public int SystemId { get; set; }
public string ForeNames { get; set; }
public string Surname { get; set; }
public string EmailAddress { get; set; }
}
private class ReportData
{
public ICollection<ReportLine> ResultSet { get; set; }
}
private static async Task ConnectApi()
{
// Create a new http client and set the base url for it
var client = new HttpClient();
client.BaseAddress = new Uri(https://webapi.myworkpal.co.uk); //This url will vary depending on the platform being used
// First you need to get a bearer token to be able to access the api.
// You do this by posting the client api credentials to a token end point
var formContent = new FormUrlEncodedContent(new[] {
new KeyValuePair<string, string>("grant_type", "client_credentials"),
new KeyValuePair<string, string>("scope", "api"),
new KeyValuePair<string, string>("client_id", "username"), //This will change for the live implementation
new KeyValuePair<string, string>("client_secret", "password!") //This will change for the live implementation
});
var response = await client.PostAsync("/idp/connect/token", formContent);
var content = await response.Content.ReadAsStringAsync();
// The content received is in Json format. Parse this json object to retrieve the access token
var accessToken = JsonSerializer.Deserialize<IdpResponse>(content).access_token;
// Add an authorization header to the http client and add the token.
// Without this header you will not be able to get responses from the api.
// Make note of the "Bearer " bit. It is important to have this
client.DefaultRequestHeaders.Add("Authorization", "Bearer " + accessToken);
// CALL TO API ENDPOINT
}
}
}