Codeunit "Customer Experience Survey"
Obsolete
This element will become obsolete from version 27.0. This module is no longer used.
Provides methods to connect to CES.
Properties
| Name | Value |
|---|---|
| Access | Public |
| InherentEntitlements | X |
| InherentPermissions | X |
| ObsoleteReason | This module is no longer used. |
| ObsoleteState | Pending |
| ObsoleteTag | 27.0 |
Methods
RegisterEvent
Obsolete
This element will become obsolete from version 27.0. This module is no longer used.
Pushes a new event entry to the CES back-end for the current user.
procedure RegisterEvent(EventName: Text): Boolean
Parameters
| Name | Type | Description |
|---|---|---|
| EventName | Text |
Name of the event to be registered. |
Returns
| Type | Description |
|---|---|
| Boolean |
Returns true if the request was successful. |
GetEligibility
Obsolete
This element will become obsolete from version 27.0. This module is no longer used.
Gets the eligibility of the current user for the indicated survey. Making this API call resets the eligibility flag (this avoids double prompting).
procedure GetEligibility(SurveyName: Text, var FormsProId: Text, var FormsProEligibilityId: Text, var IsEligible: Boolean): Boolean
Parameters
| Name | Type | Description |
|---|---|---|
| SurveyName | Text |
Name of the survey. |
| FormsProId | Text |
ID of the survey. |
| FormsProEligibilityId | Text |
This ID is used to render survey. |
| IsEligible | Boolean |
True means that the user is eligible for prompting, and false means the user is not eligible and should not be prompted. |
Returns
| Type | Description |
|---|---|
| Boolean |
Returns true if the request was successful. |
RegisterEventAndGetEligibility
Obsolete
This element will become obsolete from version 27.0. This module is no longer used.
Push a new event entry to the CES back-end, and get the eligibility of a given user for the indicated survey. This endpoint combines the functionality of the above 2 endpoints (adding an event and checking user eligibility).
procedure RegisterEventAndGetEligibility(EventName: Text, SurveyName: Text, var FormsProId: Text, var FormsProEligibilityId: Text, var IsEligible: Boolean): Boolean
Parameters
| Name | Type | Description |
|---|---|---|
| EventName | Text | |
| SurveyName | Text |
Name of the survey. |
| FormsProId | Text |
ID of the survey. |
| FormsProEligibilityId | Text |
This ID is used to render survey. |
| IsEligible | Boolean |
Returns
| Type | Description |
|---|---|
| Boolean |
Returns true if the request was successful. |
GetSurvey
Obsolete
This element will become obsolete from version 27.0. This module is no longer used.
Returns the details for a single survey
procedure GetSurvey(SurveyName: Text, var CustomerExperienceSurvey: Record "Customer Experience Survey" temporary): Boolean
Parameters
| Name | Type | Description |
|---|---|---|
| SurveyName | Text |
Name of the survey. |
| CustomerExperienceSurvey | Table System.Feedback."Customer Experience Survey" |
Survey record with details. |
Returns
| Type | Description |
|---|---|
| Boolean |
Returns true if the request was successful. |
RenderSurvey
Obsolete
This element will become obsolete from version 27.0. This module is no longer used.
Renders a given survey
procedure RenderSurvey(SurveyName: Text, FormsProId: Text, FormsProEligibilityId: Text)
Parameters
| Name | Type | Description |
|---|---|---|
| SurveyName | Text |
Name of the survey. |
| FormsProId | Text |
Name of the survey. |
| FormsProEligibilityId | Text |
This ID is used to render survey. |