Update Employee Family

POST/empeo/api/v1/employees/family

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

familyRefNo

string

required

Employee family reference number for update (can view from Get Employee List)

relationShipId

integer | null

required

Relationship ID (can view in Get mastertypes API)

titleId

integer | null

optional

Title of the family member (can view in Get name prefixes API)

name

string | null

required

First names of the family members associated with the employee

surname

string | null

required

Last names of the family members associated with the employee

dateOfBirth

string | null

optional

Family date of birth (format : YYYY-MM-DD)

nationalityId

integer | null

optional

Nationality ID (can view in Get mastertypes API)

religionId

integer | null

optional

Religion ID (can view in Get mastertypes API)

RaceId

integer | null

optional

Race ID (can view in Get mastertypes API)

contact

string | null

required

Employee family contact number

isStudy

boolean | null

required

Status of education (Required only if update children data)

{
  "employeeRefId": "23003",
  "companyName": "empeo Dev Test",
  "familyRefNo": 7812,
  "relationShipId": 130010,
  "title": 2,
  "name": "John",
  "surname": "Doe",
  "dateOfBirth": "1990-01-01",
  "nationalityId": 500001,
  "ReligionId": 200003,
  "IsStudy": false
}

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