User endpoints
Base URL: /tenants/{tenantName}/users
Search
Get specific user by id and/or reference number and/or email address.
URL: /tenants/{tenantName}/users/search
Method: GET
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | No | The id of the user to retrieve |
| refNum | String | No | The reference number of the user to retrieve |
| String | No | The email address of the user to retrieve |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Response body
{
id: integer (Int32),
firstName: string,
lastName: string,
caseOwnerId: integer (Int32),
mentorId: integer (Int32),
phone: string,
referenceNumber: string,
groupId: integer (Int32),
jobActiveSync: true,
email: string,
username: string,
status: string,
dateOfBirth: string,
caseOwnerFirstName: string,
caseOwnerLastName: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
programmeId: integer (Int32),
programmeStartDate: string,
employerId: integer (Int32),
employerAddressId: integer (Int32),
managerFirstName: string,
managerLastName: string,
managerEmail: string,
managerPhone: string,
IAEnglish: string,
IAMath: string,
IAICT: string,
diagEnglish: string,
diagMath: string,
diagIct: string,
title: string,
preferredName: string,
personalEmail: string,
gender: string,
authenticationType: string,
plannedHours: integer (Int32),
weeklyHours: integer (Int32),
managerId: integer (Int32)
}
Create user
Creates a new user.
URL: /tenants/{tenantName}/users
Method: POST
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
Request body
{
firstName: string,
lastName: string,
caseOwnerId: integer (Int32),
mentorId: integer (Int32),
phone: string,
referenceNumber: string,
groupId: integer (Int32),
jobActiveSync: true,
email: string,
username: string,
status: string,
dateOfBirth: string,
caseOwnerFirstName: string,
caseOwnerLastName: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
programmeId: integer (Int32),
programmeStartDate: string,
employerId: integer (Int32),
employerAddressId: integer (Int32),
managerFirstName: string,
managerLastName: string,
managerEmail: string,
managerPhone: string,
IAEnglish: string,
IAMath: string,
IAICT: string,
diagEnglish: string,
diagMath: string,
diagIct: string,
title: string,
preferredName: string,
personalEmail: string,
gender: string,
authenticationType: string,
plannedHours: integer (Int32),
weeklyHours: integer (Int32),
managerId: integer (Int32)
}
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
Response body
{
id: integer (Int32),
firstName: string,
lastName: string,
caseOwnerId: integer (Int32),
mentorId: integer (Int32),
phone: string,
referenceNumber: string,
groupId: integer (Int32),
jobActiveSync: true,
email: string,
username: string,
status: string,
dateOfBirth: string,
caseOwnerFirstName: string,
caseOwnerLastName: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
programmeId: integer (Int32),
programmeStartDate: string,
employerId: integer (Int32),
employerAddressId: integer (Int32),
managerFirstName: string,
managerLastName: string,
managerEmail: string,
managerPhone: string,
IAEnglish: string,
IAMath: string,
IAICT: string,
diagEnglish: string,
diagMath: string,
diagIct: string,
title: string,
preferredName: string,
personalEmail: string,
gender: string,
authenticationType: string,
plannedHours: integer (Int32),
weeklyHours: integer (Int32),
managerId: integer (Int32)
}
Update user
Updates an existing user.
URL: /tenants/{tenantName}/users/{userId}
Method: PUT
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user to update |
Request body
{
firstName: string,
lastName: string,
caseOwnerId: integer (Int32),
mentorId: integer (Int32),
phone: string,
referenceNumber: string,
groupId: integer (Int32),
jobActiveSync: true,
email: string,
username: string,
status: string,
dateOfBirth: string,
caseOwnerFirstName: string,
caseOwnerLastName: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
programmeId: integer (Int32),
programmeStartDate: string,
employerId: integer (Int32),
employerAddressId: integer (Int32),
managerFirstName: string,
managerLastName: string,
managerEmail: string,
managerPhone: string,
IAEnglish: string,
IAMath: string,
IAICT: string,
diagEnglish: string,
diagMath: string,
diagIct: string,
title: string,
preferredName: string,
personalEmail: string,
gender: string,
authenticationType: string,
plannedHours: integer (Int32),
weeklyHours: integer (Int32),
managerId: integer (Int32)
}
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Response body
{
id: integer (Int32),
firstName: string,
lastName: string,
caseOwnerId: integer (Int32),
mentorId: integer (Int32),
phone: string,
referenceNumber: string,
groupId: integer (Int32),
jobActiveSync: true,
email: string,
username: string,
status: string,
dateOfBirth: string,
caseOwnerFirstName: string,
caseOwnerLastName: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
programmeId: integer (Int32),
programmeStartDate: string,
employerId: integer (Int32),
employerAddressId: integer (Int32),
managerFirstName: string,
managerLastName: string,
managerEmail: string,
managerPhone: string,
IAEnglish: string,
IAMath: string,
IAICT: string,
diagEnglish: string,
diagMath: string,
diagIct: string,
title: string,
preferredName: string,
personalEmail: string,
gender: string,
authenticationType: string,
plannedHours: integer (Int32),
weeklyHours: integer (Int32),
managerId: integer (Int32)
}
Deactivate user
Deactivate an existing user where found.
URL: /tenants/{tenantName}/users/{userId}
Method: DELETE
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user to deactivate |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |