Workshops and Employees | Employee

Service to manage entities of type 'Employee'.

This service extends Parties.

Overview

api/{tenantKey}/{orgKey}/workShopsCore/employees

URL	api/{tenantKey}/{orgKey}/workShopsCore/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:

ApiBaseEmployeeEmployeeExpertisesResource
ApiBaseEmployeeResource
ApiEmployeeEmployeeExpertisesResource
ApiEmployeeResource
BaseEmployeeEmployeeExpertisesResource
BaseEmployeeResource
EmployeeResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET Employees (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

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}/workShopsCore/employees/extension/odata

GET /workShopsCore/employees/extension/odata

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}/workShopsCore/employees/{id}/extension

GET /workShopsCore/employees/{id}/extension

GET Employee by key

Returns the entity record that matches the specified key.

The following elements are required:

partyKey

(string) The key for the party. Uniquely identifies the entity/party within the organization.

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}/workShopsCore/employees/{partyKey}/extension

GET /workShopsCore/employees/{partyKey}/extension

GET Employees (with Party)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/workShopsCore/employees

GET /workShopsCore/employees

GET Employees (with Party) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

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 BaseEmployeeResource.

Response status codes:

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

Resource URL:

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

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

GET Employee (with Party) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

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

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}/workShopsCore/employees/{id}

GET /workShopsCore/employees/{id}

GET Employee (with Party) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

partyKey

(string) The key for the party. Uniquely identifies the entity/party within the organization.

Response:

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

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}/workShopsCore/employees/{partyKey}

GET /workShopsCore/employees/{partyKey}

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}/workShopsCore/employees/extension

POST /workShopsCore/employees/extension

POST Employees (with ApiBaseEmployee)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

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 ApiBaseEmployeeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/workShopsCore/employees

POST /workShopsCore/employees

POST Employee Expertise

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
value	(ApiEmployeeEmployeeExpertisesResource) The ApiEmployeeEmployeeExpertisesResource instance. See ApiEmployeeEmployeeExpertisesResource.

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}/workShopsCore/employees/{partyKey}/employeeExpertises

POST /workShopsCore/employees/{partyKey}/employeeExpertises

PUT Operations

PUT Set ContractEndDate Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/contractEndDate

PUT /workShopsCore/employees/{partyKey}/contractEndDate

PUT Set ContractStartDate Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/contractStartDate

PUT /workShopsCore/employees/{partyKey}/contractStartDate

PUT Set Expertise EmployeeExpertise

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/employeeExpertises/{lineId}/expertise

PUT /workShopsCore/employees/{partyKey}/employeeExpertises/{lineId}/expertise

PUT Set ExternalReferenceID Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/externalReferenceID

PUT /workShopsCore/employees/{partyKey}/externalReferenceID

PUT Set IsActive Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/isActive

PUT /workShopsCore/employees/{partyKey}/isActive

PUT Set IsInternalEmployee Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/isInternalEmployee

PUT /workShopsCore/employees/{partyKey}/isInternalEmployee

PUT Set PhoneNumber Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/phoneNumber

PUT /workShopsCore/employees/{partyKey}/phoneNumber

PUT Set Remarks Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/remarks

PUT /workShopsCore/employees/{partyKey}/remarks

PUT Set RequesterDeviceSerialNumber Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/requesterDeviceSerialNumber

PUT /workShopsCore/employees/{partyKey}/requesterDeviceSerialNumber

PUT Set SchedulingGroup Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/schedulingGroup

PUT /workShopsCore/employees/{partyKey}/schedulingGroup

PUT Set TechnicianDeviceSerialNumber Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/technicianDeviceSerialNumber

PUT /workShopsCore/employees/{partyKey}/technicianDeviceSerialNumber

PUT Set Custom Attribute Employee

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/{customAttributeName}

PUT /workShopsCore/employees/{partyKey}/{customAttributeName}

PUT Set Custom Attribute EmployeeExpertise

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

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
lineId	(string) The detail identifier.
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}/workShopsCore/employees/{partyKey}/employeeExpertises/{lineId}/{customAttributeName}

PUT /workShopsCore/employees/{partyKey}/employeeExpertises/{lineId}/{customAttributeName}

DELETE Operations

DELETE Employee Expertise by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
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}/workShopsCore/employees/{partyKey}/employeeExpertises/{lineId}

DELETE /workShopsCore/employees/{partyKey}/employeeExpertises/{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}/workShopsCore/employees/{id}

DELETE /workShopsCore/employees/{id}

DELETE Employee by key

Deletes the entity record that matches the specified key.

The following elements are required:

partyKey

(string) The key for the party. Uniquely identifies the entity/party within the organization.

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}/workShopsCore/employees/{partyKey}

DELETE /workShopsCore/employees/{partyKey}

Resources

ApiBaseEmployeeEmployeeExpertisesResource

The following elements are required:

expertise

(string) Specialty.

ApiBaseEmployeeResource

The following elements are required:

isInternalEmployee	(bool) Is Internal Employee.
schedulingGroup	(string) Default Scheduling Group.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
name	(string) The name for the party.
isExternallyManaged	(bool) A flag indicating if the party is externally managed.
oneTimeParty	(bool) One Time Party.
currency	(string) The party's default currency.
country	(string) The party's country.
isPerson	(bool) Indicates that this entity is a person.
isEmployee	(bool) Indicates that this entity is an employee.

The following elements are optional:

externalReferenceID	(string) External Reference ID.
phoneNumber	(string) Phone Number.
contractStartDate	(DateTime) Contract Start Date.
contractEndDate	(DateTime) Contract End Date.
remarks	(string) Remarks.
employeeExpertises	(List of ApiBaseEmployeeEmployeeExpertisesResource) Employee Specialties. See ApiBaseEmployeeEmployeeExpertisesResource.
requesterDeviceSerialNumber	(string) Requester Device Serial Number.
technicianDeviceSerialNumber	(string) Technician Device Serial Number.
searchTerm	(string) The search term.
keyword	(string) Keyword.
companyTaxID	(string) The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
electronicMail	(string) The electronic mail for the party.
telephone	(string) The telephone for the party.
mobile	(string) The mobile for the party.
websiteUrl	(string) The website url for the party.
notes	(string) The notes for the party.
picture	(string) The picture for the party.
streetName	(string) The party main address street's name.
buildingNumber	(string) The party main address building's number.
postalZone	(string) The party main address postal zone.
cityName	(string) The party main address city's name.
contactName	(string) The party main contact's name.
contactTitle	(string) The party main contact's title.
username	(string) The party's Identity Username.
externalId	(string) The external identifier for the party.
externalVersion	(string) The external version for the party.
address	(string) The party's main address.
contact	(string) The party's main contact.
culture	(string) The culture for the party.
partyAccountType	(string) The type of party for accounting purposes.
isSupplier	(bool) Indicates that this entity is a Supplier.
isCustomer	(bool) Indicates that this entity is an customer.

ApiEmployeeEmployeeExpertisesResource

The following elements are required:

expertise

(string) Specialty.

ApiEmployeeResource

The following elements are required:

isInternalEmployee	(bool) Is Internal Employee.
schedulingGroup	(string) Default Scheduling Group.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

externalReferenceID	(string) External Reference ID.
phoneNumber	(string) Phone Number.
contractStartDate	(DateTime) Contract Start Date.
contractEndDate	(DateTime) Contract End Date.
remarks	(string) Remarks.
employeeExpertises	(List of ApiEmployeeEmployeeExpertisesResource) Employee Specialties. See ApiEmployeeEmployeeExpertisesResource.
requesterDeviceSerialNumber	(string) Requester Device Serial Number.
technicianDeviceSerialNumber	(string) Technician Device Serial Number.

BaseEmployeeEmployeeExpertisesResource

The following elements are required:

expertise

(string) Specialty.

BaseEmployeeResource

The following elements are required:

isInternalEmployee	(bool) Is Internal Employee.
schedulingGroup	(string) Default Scheduling Group.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
name	(string) The name for the party.
isExternallyManaged	(bool) A flag indicating if the party is externally managed.
oneTimeParty	(bool) One Time Party.
currency	(string) The party's default currency.
country	(string) The party's country.
isPerson	(bool) Indicates that this entity is a person.
isEmployee	(bool) Indicates that this entity is an employee.

The following elements are optional:

externalReferenceID	(string) External Reference ID.
phoneNumber	(string) Phone Number.
contractStartDate	(DateTime) Contract Start Date.
contractEndDate	(DateTime) Contract End Date.
remarks	(string) Remarks.
employeeExpertises	(List of BaseEmployeeEmployeeExpertisesResource) Employee Specialties. See BaseEmployeeEmployeeExpertisesResource.
requesterDeviceSerialNumber	(string) Requester Device Serial Number.
technicianDeviceSerialNumber	(string) Technician Device Serial Number.
searchTerm	(string) The search term.
keyword	(string) Keyword.
companyTaxID	(string) The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
electronicMail	(string) The electronic mail for the party.
telephone	(string) The telephone for the party.
mobile	(string) The mobile for the party.
websiteUrl	(string) The website url for the party.
notes	(string) The notes for the party.
picture	(string) The picture for the party.
streetName	(string) The party main address street's name.
buildingNumber	(string) The party main address building's number.
postalZone	(string) The party main address postal zone.
cityName	(string) The party main address city's name.
contactName	(string) The party main contact's name.
contactTitle	(string) The party main contact's title.
username	(string) The party's Identity Username.
externalId	(string) The external identifier for the party.
externalVersion	(string) The external version for the party.
address	(string) The party's main address.
contact	(string) The party's main contact.
culture	(string) The culture for the party.
partyAccountType	(string) The type of party for accounting purposes.
isSupplier	(bool) Indicates that this entity is a Supplier.
isCustomer	(bool) Indicates that this entity is an customer.

EmployeeResource

The following elements are required:

isInternalEmployee	(bool) Is Internal Employee.
schedulingGroup	(string) Default Scheduling Group. (fk) Allowed value: the natural key of a record of type SchedulingGroup. These records are accessibly through the SchedulingGroups service.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

externalReferenceID	(string) External Reference ID.
phoneNumber	(string) Phone Number.
contractStartDate	(DateTime) Contract Start Date.
contractEndDate	(DateTime) Contract End Date.
remarks	(string) Remarks.
employeeExpertises	(List of EmployeeExpertiseResource) Employee Specialties. See EmployeeExpertiseResource.
requesterDeviceSerialNumber	(string) Requester Device Serial Number.
technicianDeviceSerialNumber	(string) Technician Device Serial Number.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.