Update Employee Information

POST/empeo/api/v1/employees/Information

All fields that have tag 'Required' and 'Nullable' is mean that field required only when adding data, If update data that field is nullable

Request

Header Params

Content-Type

string

required

Accepted value: application/json

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

Api subscription key get from the OpenAPI integration setting page

Example:

WPe123a9RKbcfLQNSztr45

Authorization

string

required

Authorization credential utilized in API requests

Example:

bearer {token}

employeeRefId

string

required

Unique identifier for referring to employees (Employee No.)

companyName

string

required

Employee company name

GenderId

integer | null

required

Gender ID (1 = Male, 2 = Female, 3 = Other)

TitleId

integer | null

required

Title ID of the employee (can view in Get name prefixes API)

ReligionId

integer | null

optional

Religion ID (can view in Get mastertypes API)

NationalityId

integer | null

optional

Nationality ID (can view in Get mastertypes API)

raceId

integer | null

optional

Race ID (can view in Get mastertypes API)

Height

integer | null

optional

Employee height

Weight

integer | null

optional

Employee weight

BloodTypeId

integer | null

optional

Blood type (can view in Get mastertypes API)

MilitaryStatusId

integer | null

optional

Military status ID (can view in Get mastertypes API)

MaritalStatusId

integer | null

optional

Marital status ID (can view in Get mastertypes API)

emailAddress

string | null

optional

Email address of the employee (Work)

telephoneNo

string | null

optional

Contact number of the employee (work)

employmentTypeId

integer | null

required

Employee employment type (1 = Part Time, 2 = Apprentice, 3 = Temporary, 4 = Daily, 5 = Permanent)

employmentStatusId

integer | null

required

Employee work status (1 = Probation, 2 = Permanent, 3 = Resign, 4 = Waiting to start work)

organizationName

string | null

required

Name of the department of the employee. Ex. Org chart is "Chief Executive Officer (1)> Human Resources Department (2)> HR Team (3)> HR Manager (4)" if organizationName is HR Team, organizationLevel is 3

organizationLevels

integer | null

required

Employee department levels. Ex. Org chart is "Chief Executive Officer (1)> Human Resources Department (2)> HR Team (3)> HR Manager (4)" if organizationName is HR Team, organizationLevel is 3

{
  "employeeRefId": "23003",
  "companyName": "empeo Dev Test",
  "GenderId": 1,
  "ReligionId": 200001,
  "Height": 175,
  "MaritalStatusId": 900001
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

object {0}

{
  "statusCode": 200,
  "message": "OK",
  "data": {
    "message": "Update successfully",
    "result": true
  }
}

Last modified: a year ago