Home Page > Integration > REST API > Employees > Files

Files

Employees/:id/Files

This endpoint is used for manipulating Files attached to an Employee Object. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Employee nested File object takes on the following JSON object:

[
    {
        "id": "<int>",
        "<rest_code>": "<field data type dependent>"
    }
]

 

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

GET

This verb is used for retrieving resources, it is subject to the parameters mentioned in the overview and all fields mentioned above are searchable.

 

PUT

This verb is used to modify the File objects attached to this Object.

 

POST

This verb is used for adding File's to an Employee. Fields that are flagged as required must be included.

 

DELETE

This verb is used for removing a File from an Employee. It follows the same syntax as the POST example, except the verb changes.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.