Update Employee Qualification

Updates a qualification for an employee.

Request

PUT https://api.nzpayroll.co.nz/api/v2/ess/{employeeId}/qualification/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
employeeId string Required

Request body

The request body takes a complete EssEmployeeQualificationModel resource, containing the following writable properties:

{
    "documents": [
        {
            "dateCreated": "date-time",
            "id": "int32",
            "name": "string",
            "url": "string",
            "visible": "boolean"
        }
    ],
    "expiryDate": "date-time",
    "hasQualification": "boolean",
    "id": "int32",
    "issueDate": "date-time",
    "name": "string",
    "qualificationId": "int32",
    "referenceNumber": "string"
}

Properties

Name Type Description
documents[] array
documents[].dateCreated date-time DateTime
documents[].id int32 Int32
documents[].name string String
documents[].url string String
documents[].visible boolean Boolean
expiryDate date-time Nullable
hasQualification boolean Boolean
id int32 Int32
issueDate date-time Nullable
name string String
qualificationId int32 Int32
referenceNumber string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK