General - Edit an employee's information

API Url

Used to edit information for a single employee.

PUT

http://localhost:16010/ProMarkREST/rest/General/employees/{empId}

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
empId	String	Employee Id.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
employees	Object[]	Collection with employee data.
address1`optional`	String	Address1
address2`optional`	String	Address2
address3`optional`	String	Address3
cardNo`optional`	String	Card number.
city`optional`	String	City
countryCode`optional`	String	Country Code
dateOfBirth`optional`	Date	Employee birthday.
email`optional`	String	Email address.
email2`optional`	String	Email address 2
empId	String	Employee Id.
empNo	String	Employee number.
firstName`optional`	String	Employee first name.
gender`optional`	String	Gender
homePhone`optional`	String	Home Phone.
info1`optional`	String	Employee note1
info2`optional`	String	Employee note2
info3`optional`	String	Employee note3
info4`optional`	String	Employee note4
info5`optional`	String	Employee note5
initials`optional`	String	Employee initials.
localPhone`optional`	String	local Phone.
lockStatus`optional`	Boolean	Lock Status
mobilePhone`optional`	String	Employee phone number.
postalCode`optional`	String	Postal code
province`optional`	String	Province
surname`optional`	String	Employee last name.
workPhone`optional`	String	work Phone.

Request example:

{
   "request": {
      "data": {
         "employees": [
            {
               "cardNo": "1",
               "firstName": "John",
               "surname": "Doe",
               "initials": "DT",
               "mobile": "99999",
               "dateOfBirth": "1985-02-28",
               "dateOfEmployment": "2006-10-01",
               "email": "john@my-company.com"
            }
         ]
      }
   }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
errorCode	Number	Error code.
errorMessage	String	Error description.

Error example:

HTTP/1.1 404 Not found
{
   "response": {
      "errorCode": 75,
      "errorMessage": "Employee does not exist"
   }
}