People | Employee

Service to manage entities of type 'Employee'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/employees

URL	api/{tenantKey}/{orgKey}/peopleCore/employees
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiEmployeeEmployeeEducationsResource
ApiEmployeeResource
ApiEmployeeSubscribersResource
EmployeeEducationResource
EmployeeResource
EmployeeSubscriberResource
EmployeeSummaryResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

DocumentType
GenderType

GET Operations

GET Employees

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See EmployeeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees

GET /peopleCore/employees

GET Employees (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See EmployeeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees?page={page}&pageSize={pageSize}

GET /peopleCore/employees?page={page}&pageSize={pageSize}

GET Employee by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See EmployeeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{id}

GET /peopleCore/employees/{id}

GET Employee by key

Returns the entity record that matches the specified key.

The following elements are required:

employeeKey

(string) Employee.

Response:

When successful, the response body contains the entity record. See EmployeeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}

GET /peopleCore/employees/{employeeKey}

GET Print Employee by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{id}/print?template={template}

GET /peopleCore/employees/{id}/print?template={template}

GET Print Employee by key

Prints the specified entity record.

The following elements are required:

employeeKey

(string) Employee.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/print

GET /peopleCore/employees/{employeeKey}/print

GET Original Print EmployeeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{id}/printOriginal?template={template}

GET /peopleCore/employees/{id}/printOriginal?template={template}

GET Original Print Employee by key

Prints the specified entity record.

The following elements are required:

employeeKey

(string) Employee.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/printOriginal

GET /peopleCore/employees/{employeeKey}/printOriginal

GET Employee Picture.

Returns the value of attribute 'Picture' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{id}/picture

GET /peopleCore/employees/{id}/picture

GET Get Employee Summary

Custom operation 'GetEmployeeSummary'.

The following elements are required:

key	(string) key.

Response:

When successful, the response body contains a resource of type 'EmployeeSummaryResource'. See EmployeeSummaryResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/getEmployeeSummary

GET /peopleCore/employees/getEmployeeSummary

POST Operations

POST Employees

Creates a new entity record.

The following elements are required:

employeeResource

(ApiEmployeeResource) The request body should contain the entity record that should be created.
See ApiEmployeeResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiEmployeeResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees

POST /peopleCore/employees

POST Employee

Inserts a new 'Employee Education' in the 'Employee'.

The following elements are required:

employeeKey	(string) Employee.
value	(ApiEmployeeEmployeeEducationsResource) The ApiEmployeeEmployeeEducationsResource instance. See ApiEmployeeEmployeeEducationsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeEducations

POST /peopleCore/employees/{employeeKey}/employeeEducations

POST Employee

Inserts a new 'Employee Subscriber' in the 'Employee'.

The following elements are required:

employeeKey	(string) Employee.
value	(ApiEmployeeSubscribersResource) The ApiEmployeeSubscribersResource instance. See ApiEmployeeSubscribersResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/subscribers

POST /peopleCore/employees/{employeeKey}/subscribers

POST Employee Activate

Custom operation 'EmployeeActivate'.

The following elements are required:

employeeKey

(string) EmployeeKey.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/employeeActivate/{employeeKey}

POST /peopleCore/employees/employeeActivate/{employeeKey}

POST Employee Deactivate

Custom operation 'EmployeeDeactivate'.

The following elements are required:

employeeKey

(string) EmployeeKey.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/employeeDeactivate/{employeeKey}

POST /peopleCore/employees/employeeDeactivate/{employeeKey}

PUT Operations

PUT Set BirthDate Employee

Updates the value of attribute 'BirthDate' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/birthDate

PUT /peopleCore/employees/{employeeKey}/birthDate

PUT Set BuildingNumber Employee

Updates the value of attribute 'BuildingNumber' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/buildingNumber

PUT /peopleCore/employees/{employeeKey}/buildingNumber

PUT Set Career Employee

Updates the value of attribute 'Career' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/career

PUT /peopleCore/employees/{employeeKey}/career

PUT Set CityName Employee

Updates the value of attribute 'CityName' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/cityName

PUT /peopleCore/employees/{employeeKey}/cityName

PUT Set Country Employee

Updates the value of attribute 'Country' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/country

PUT /peopleCore/employees/{employeeKey}/country

PUT Set Country EmployeeEducation

Updates the value of attribute 'Country' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/country

PUT /peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/country

PUT Set Education EmployeeEducation

Updates the value of attribute 'Education' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/education

PUT /peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/education

PUT Set EducationalInstitution EmployeeEducation

Updates the value of attribute 'EducationalInstitution' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/educationalInstitution

PUT /peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/educationalInstitution

PUT Set ElectronicMail Employee

Updates the value of attribute 'ElectronicMail' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/electronicMail

PUT /peopleCore/employees/{employeeKey}/electronicMail

PUT Set EmergencyContact Employee

Updates the value of attribute 'EmergencyContact' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/emergencyContact

PUT /peopleCore/employees/{employeeKey}/emergencyContact

PUT Set EmergencyContactName Employee

Updates the value of attribute 'EmergencyContactName' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/emergencyContactName

PUT /peopleCore/employees/{employeeKey}/emergencyContactName

PUT Set EmergencyContactRelationship Employee

Updates the value of attribute 'EmergencyContactRelationship' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/emergencyContactRelationship

PUT /peopleCore/employees/{employeeKey}/emergencyContactRelationship

PUT Set EmployeeKey Employee

Updates the value of attribute 'EmployeeKey' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeKey

PUT /peopleCore/employees/{employeeKey}/employeeKey

PUT Set Gender Employee

Updates the value of attribute 'Gender' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(enum GenderType) The request body should contain the new value for the attribute. See GenderType.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/gender

PUT /peopleCore/employees/{employeeKey}/gender

PUT Set IdDocIssueDate Employee

Updates the value of attribute 'IdDocIssueDate' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/idDocIssueDate

PUT /peopleCore/employees/{employeeKey}/idDocIssueDate

PUT Set IdDocIssueLocation Employee

Updates the value of attribute 'IdDocIssueLocation' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/idDocIssueLocation

PUT /peopleCore/employees/{employeeKey}/idDocIssueLocation

PUT Set IdDocNumber Employee

Updates the value of attribute 'IdDocNumber' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/idDocNumber

PUT /peopleCore/employees/{employeeKey}/idDocNumber

PUT Set IdDocType Employee

Updates the value of attribute 'IdDocType' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(enum DocumentType) The request body should contain the new value for the attribute. See DocumentType.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/idDocType

PUT /peopleCore/employees/{employeeKey}/idDocType

PUT Set IdDocValidity Employee

Updates the value of attribute 'IdDocValidity' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/idDocValidity

PUT /peopleCore/employees/{employeeKey}/idDocValidity

PUT Set IsActive Employee

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/isActive

PUT /peopleCore/employees/{employeeKey}/isActive

PUT Set JobGrade Employee

Updates the value of attribute 'JobGrade' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/jobGrade

PUT /peopleCore/employees/{employeeKey}/jobGrade

PUT Set Mobile Employee

Updates the value of attribute 'Mobile' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/mobile

PUT /peopleCore/employees/{employeeKey}/mobile

PUT Set Name Employee

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/name

PUT /peopleCore/employees/{employeeKey}/name

PUT Set Nationality Employee

Updates the value of attribute 'Nationality' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/nationality

PUT /peopleCore/employees/{employeeKey}/nationality

PUT Set NISS Employee

Updates the value of attribute 'NISS' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/nISS

PUT /peopleCore/employees/{employeeKey}/nISS

PUT Set ObtainedDate EmployeeEducation

Updates the value of attribute 'ObtainedDate' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The detail identifier.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/obtainedDate

PUT /peopleCore/employees/{employeeKey}/employeeEducations/{lineId}/obtainedDate

PUT Set Party Employee

Updates the value of attribute 'Party' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/party

PUT /peopleCore/employees/{employeeKey}/party

PUT Set PersonalContact Employee

Updates the value of attribute 'PersonalContact' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/personalContact

PUT /peopleCore/employees/{employeeKey}/personalContact

PUT Set Picture Employee

Updates the value of attribute 'Picture' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/picture

PUT /peopleCore/employees/{employeeKey}/picture

PUT Set Position Employee

Updates the value of attribute 'Position' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/position

PUT /peopleCore/employees/{employeeKey}/position

PUT Set PostalZone Employee

Updates the value of attribute 'PostalZone' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/postalZone

PUT /peopleCore/employees/{employeeKey}/postalZone

PUT Set Remarks Employee

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/remarks

PUT /peopleCore/employees/{employeeKey}/remarks

PUT Set SearchTerm Employee

Updates the value of attribute 'SearchTerm' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/searchTerm

PUT /peopleCore/employees/{employeeKey}/searchTerm

PUT Set ShowInviteToRoseEmployee Employee

Updates the value of attribute 'ShowInviteToRoseEmployee' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/showInviteToRoseEmployee

PUT /peopleCore/employees/{employeeKey}/showInviteToRoseEmployee

PUT Set StreetName Employee

Updates the value of attribute 'StreetName' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/streetName

PUT /peopleCore/employees/{employeeKey}/streetName

PUT Set SubscriberId EmployeeSubscriber

Updates the value of attribute 'SubscriberId' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/subscribers/{lineId}/subscriberId

PUT /peopleCore/employees/{employeeKey}/subscribers/{lineId}/subscriberId

PUT Set SubscriberType EmployeeSubscriber

Updates the value of attribute 'SubscriberType' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/subscribers/{lineId}/subscriberType

PUT /peopleCore/employees/{employeeKey}/subscribers/{lineId}/subscriberType

PUT Set TaxID Employee

Updates the value of attribute 'TaxID' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/taxID

PUT /peopleCore/employees/{employeeKey}/taxID

PUT Set WebsiteUrl Employee

Updates the value of attribute 'WebsiteUrl' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/websiteUrl

PUT /peopleCore/employees/{employeeKey}/websiteUrl

PUT Set Custom Attribute Employee

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

employeeKey	(string) Employee
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/{customAttributeName}

PUT /peopleCore/employees/{employeeKey}/{customAttributeName}

DELETE Operations

DELETE Employee Education by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/employeeEducations/{lineId}

DELETE /peopleCore/employees/{employeeKey}/employeeEducations/{lineId}

DELETE Employee Subscriber by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

employeeKey	(string) Employee.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}/subscribers/{lineId}

DELETE /peopleCore/employees/{employeeKey}/subscribers/{lineId}

DELETE Employee by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{id}

DELETE /peopleCore/employees/{id}

DELETE Employee by key

Deletes the entity record that matches the specified key.

The following elements are required:

employeeKey

(string) Employee.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/employees/{employeeKey}

DELETE /peopleCore/employees/{employeeKey}

Resources

ApiEmployeeEmployeeEducationsResource

The following elements are required:

country	(string) Country.
education	(string) Education.

The following elements are optional:

educationalInstitution	(string) Educational Institution.
obtainedDate	(DateTime) Obtained Date.

ApiEmployeeResource

The following elements are required:

employeeKey	(string) Employee.
searchTerm	(string) Short Name.
birthDate	(DateTime) Birth Date.
gender	(enum GenderType) Gender. See GenderType.
idDocType	(enum DocumentType) Document Type. See DocumentType.
idDocNumber	(string) Number.
idDocValidity	(DateTime) Issue Validity.
country	(string) The party's country.
taxID	(string) The employee tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
showInviteToRoseEmployee	(bool) This attribute is not persisted and define if Invite to Rose Employee button must be visible in view.
nationality	(string) Nationality.

The following elements are optional:

name	(string) Name.
picture	(string) Photo.
streetName	(string) Street Name.
buildingNumber	(string) Building Number.
postalZone	(string) Postal Zone.
cityName	(string) City Name.
electronicMail	(string) Email.
mobile	(string) Mobile.
websiteUrl	(string) Website.
idDocIssueLocation	(string) Issue Location.
idDocIssueDate	(DateTime) Issue Date.
position	(string) Position.
career	(string) Career.
jobGrade	(string) Job Grade.
party	(string) Party.
employeeEducations	(List of ApiEmployeeEmployeeEducationsResource) Employee Educations. See ApiEmployeeEmployeeEducationsResource.
emergencyContactRelationship	(string) Relationship.
emergencyContactName	(string) Name.
emergencyContact	(string) Contact.
remarks	(string) Remarks.
personalContact	(string) Personal Contact.
nISS	(string) NISS.
subscribers	(List of ApiEmployeeSubscribersResource) Other Subscriber Numbers. See ApiEmployeeSubscribersResource.

ApiEmployeeSubscribersResource

The following elements are required:

subscriberType	(string) Type.
subscriberId	(string) Subscriber Number.

EmployeeEducationResource

The following elements are required:

country	(string) Country.
education	(string) Education.

The following elements are optional:

educationalInstitution	(string) Educational Institution.
obtainedDate	(DateTime) Obtained Date.

EmployeeResource

The following elements are required:

employeeKey	(string) Employee.
searchTerm	(string) Short Name.
birthDate	(DateTime) Birth Date.
gender	(enum GenderType) Gender. See GenderType.
idDocType	(enum DocumentType) Document Type. See DocumentType.
idDocNumber	(string) Number.
idDocValidity	(DateTime) Issue Validity.
country	(string) The party's country.
taxID	(string) The employee tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
showInviteToRoseEmployee	(bool) This attribute is not persisted and define if Invite to Rose Employee button must be visible in view.
nationality	(string) Nationality.

The following elements are optional:

name	(string) Name.
picture	(string) Photo.
streetName	(string) Street Name.
buildingNumber	(string) Building Number.
postalZone	(string) Postal Zone.
cityName	(string) City Name.
electronicMail	(string) Email.
mobile	(string) Mobile.
websiteUrl	(string) Website.
idDocIssueLocation	(string) Issue Location.
idDocIssueDate	(DateTime) Issue Date.
position	(string) Position.
career	(string) Career.
jobGrade	(string) Job Grade.
party	(string) Party.
employeeEducations	(List of EmployeeEducationResource) Employee Educations. See EmployeeEducationResource.
emergencyContactRelationship	(string) Relationship.
emergencyContactName	(string) Name.
emergencyContact	(string) Contact.
remarks	(string) Remarks.
personalContact	(string) Personal Contact.
nISS	(string) NISS.
subscribers	(List of EmployeeSubscriberResource) Other Subscriber Numbers. See EmployeeSubscriberResource.

EmployeeSubscriberResource

The following elements are required:

subscriberType	(string) Type.
subscriberId	(string) Subscriber Number.

EmployeeSummaryResource

The following elements are optional:

nameTitle	(string) Name Title.
name	(string) Name.
picture	(string) Photo.
career	(string) Career.
jobGrade	(string) Job Grade.
position	(string) Position.
electronicMail	(string) Email.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

DocumentType

1	NationalIdentification
2	Passport
3	ForeignIdentification
4	ResidenceAuthorization

GenderType

1	Undefined
2	Female
3	Male