This document provides a list of all EFS Service-Layer services. To have general information on the EFS Service-Layer, please go to this page.

As mentioned in the EFS Service-Layer overview, all requests should use the token URL parameter to authenticate the service user, for example GET https://your-efs.com/service/survey/surveys/?token=1234567890. An alternative to using the provided token, is to create a basic authentication request as specified in the HTTP protocol.

REST status codes

When using REST to access the Service Layer, the service will use the following HTTP status codes, 500 being the most common error status code and 200 being used for all successful requests.

Status	Description

Status	Description
200	The request has been processed, see end point description for expected response body
400	The validation of the entity given in the body of the request failed. Can also be caused by a malformed JSON request.
401	Can be caused by missing, invalid or expired token or username/password combination.
403	The user does not have the permission to execute this service or service is unknown or not enabled/available.
500	All regular errors and exceptions will use this status code, please see the message for additional information. In some rare exceptions, the returned value may not be json encoded.

Example for response body of a error status code:

{
  "error": {
    "message": "REST route [efs/test] not found, not activated or no access",
    "code": 403
  }
}

The title of the expandable area uses the following format:
Description | {REST method} | {SOAP method}

The examples provided are REST requests, our recommended method for accessing the Service-Layer. The list of services omits the mandatory /service/ base path. All service layer requests need to use this base path, e.g. GET /survey/surveys/ should be GET https://efs-installation.com/service/survey/surveys/ in your application.

When requesting services to be activated through the support, it is best to provide the SOAP method names, as these are unique and avoid confusion.

1 EFS
2 Employee
3 GDPR
4 Leadership
5 MySight
6 People Module / Panel
7 Portals
8 Survey

EFS

Email blocklist, global and survey based

DELETE /efs/mailblacklist/

Deletes a list of email addresses from blocklist

Request body

{
  "emailList": [
    {
      "email": "example@domain.tld",
      "surveyId": 1234
    }
  ]
}

Response body

[
    {
        "email": "example@domain.tld",
        "surveyId": 1234,
        "result": 1
    }
]

GET /efs/mailblacklist/

Get a list of all blocklisted email addresses (both global and survey). Global entries have surveyId 0.

Response body

POST /efs/mailblacklist/

Add a list of email addresses to blocklist. If surveyId is specified the email will be blocked for given survey, otherwise if omitted or if surveyId is 0, the email will be added to global blocklist.

Request body

Response body

POST /efs/mailblacklist/check

If surveyId is not specified, or the id is 0, only the global blocklist will be checked. By providing a surveyId, the system will check if the email is blocked in the given survey only. The return value is a boolean.

Request body

Response body

POST /efs/mailblacklist/getListByDateRange

Get a list of blocklisted email addresses (both global and survey related) restricted by date range.

List of EFS Service-Layer (API) services

EFS

Email blocklist, global and survey based

DELETE /efs/mailblacklist/

GET /efs/mailblacklist/

POST /efs/mailblacklist/

POST /efs/mailblacklist/check

POST /efs/mailblacklist/getListByDateRange

Mail templates

Management of EFS organisations

Management of EFS teams

Object rights

EFS admin user management

System information

Other

Employee

GDPR

Leadership

MySight

People Module / Panel

Panel circles

External surveys management

Group categories

Groups

Lotteries

Master data

Panelists

Bonus points

Panel statistics

Portals

Survey

Languages

Layouts

Static lists

Participants

Samples

Placeholders

Questionnaire

Reporting+

Survey participations

Field report / Statistics

Surveys

Translations