Employer Login endpoints
Base URL: /tenants/{tenantName}/users/employer
Search
Get specific employer login by id and/or reference number.
URL: /tenants/{tenantName}/users/employer/search
Method: GET
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| id | Integer (int32) | No | The id of the employer login to retrieve |
| refNum | String | No | The reference number of the employer login 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,
mobile: string,
referenceNumber: string,
email: string,
username: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
employerIds": [ integer array ],
employerGroupIds": [ integer array ],
gender: string,
status: string,
usePWA": boolean,
roles": [ string array],
authenticationType: string,
sendEmailInvitation: boolean
}
Create employer login
Creates a new employer login.
URL: /tenants/{tenantName}/users/employer
Method: POST
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
Request body
{
firstName: string,
lastName: string,
mobile: string,
referenceNumber: string,
email: string,
username: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
employerIds": [ integer array ],
employerGroupIds": [ integer array ],
gender: string,
status: string,
usePWA": boolean,
roles": [ string array],
authenticationType: string,
sendEmailInvitation: boolean
}
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,
mobile: string,
referenceNumber: string,
email: string,
username: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
employerIds": [ integer array ],
employerGroupIds": [ integer array ],
gender: string,
status: string,
usePWA": boolean,
roles": [ string array],
authenticationType: string,
sendEmailInvitation: boolean
}
Update employer login
Updates an existing employer login.
URL: /tenants/{tenantName}/users/employer/{employerLoginId}
Method: PUT
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| employerLoginId | Integer (int32) | Yes | The id of the employer login to update |
Request body
{
firstName: string,
lastName: string,
mobile: string,
referenceNumber: string,
email: string,
username: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
employerIds": [ integer array ],
employerGroupIds": [ integer array ],
gender: string,
status: string,
usePWA": boolean,
roles": [ string array],
authenticationType: string,
sendEmailInvitation: boolean
}
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,
mobile: string,
referenceNumber: string,
email: string,
username: string,
postCode: string,
address1: string,
address2: string,
townCity: string,
countyState: string,
employerIds": [ integer array ],
employerGroupIds": [ integer array ],
gender: string,
status: string,
usePWA": boolean,
roles": [ string array],
authenticationType: string,
sendEmailInvitation: boolean
}
Deactivate employer login
Deactivate an existing employer login where found.
URL: /tenants/{tenantName}/users/employer/{employerLoginId}
Method: DELETE
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| employerLoginId | Integer (int32) | Yes | The id of the employer login to deactivate |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |