Home Page > Integration > REST API > Employees

Employees

Employees - /REST/1/Employees/:id

This endpoint is used for manipulating Employees resources within the system. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The EmployeeKeywordCategory resource is represented with the following JSON object:

[
  {
    "code": "<string>",
    "descriptor": "<string>",
    "id": "<int>",
    "updated": "<date>",
    "<rest_code>": "<field data type dependent>"
  }
]

 

The <rest_code> is the given rest_code retrieved from the Fields that is of employee type.

GET

As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.

 

PUT

The following JSON parameters are available when updating a resource:

 

JSON Parameter Allowed value
code string
<rest_code>

dynamic per field

 

POST

Fields that are flagged as required must be included.

DELETE

The resource can be deleted using this verb and including the id in the endpoint URL.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.