Configuration Required for RESTful Retrieving Employee Documents

Using RESTful Web Services, consumer applications can retrieve documents attached to employees. The primary roles defined for the web services application users (Available Roles) must have access to the relevant document types added (Roles), as illustrated in the following screenshot. Each document type represents a type of employee data the document is associated to (for example, marriage certificate or contact details).

Because Read access is typically all that is needed to retrieve the data, you need only select that option, as shown here:

To configure access to the different document types:

1. Go to Documents > Admin > Document Types.
2. For each document type that the consumer application needs access to, do the following:
   1. Select the document type in the Document Type list.
   2. In the Available Roles column, choose the relevant primary roles attached to the consumer application user and move them to the Roles column using the arrow icons.
   3. Check the selected roles' access rights to the document type and select the accesses required. As a rule, only Read access is needed to retrieve the document.
3. Click Save, then click Refresh.