1. Home
  2. Application Programming Interface (EN)
  3. API Migration: From Classic to NG

API Migration: From Classic to NG

By migrating to Survalyzer NG there are several adaptions necessary. Even with the major release of Survalyzer our APIs remain stable from a structural perspective with two exceptions:

  1. The API endpoint doesn’t contain the tenant any longer, therefore it is necessary to handover the tenant in the GetApiToken method as parameter.
  2. The request parameters language and status, which were already obsolete in Classic were finally removed.

Beside these two breaking changes there are only non breaking changes in downloading raw data:

ClassicNGChangeDescription
CIDRemovedThis was the primary index in classic which should have never been exposed. It was replaced with InterviewId.
InterviewIdAddedUnique identifier (GUID) for an interview.
PanelRemovedThe name of the panel was not unique and wasn’t meaningful from an API perspective. It has been replaced with PanelId.
PanelIdAddedUnique identifier (Number) for a Panel.
UrlVar01 – UrlVar20AddedUrl Variables are added for the sake of completeness
ResponseCreatedInterviewCreationDateChangedFor the sake of consistency this field has been renamed.
ResponseStartInterviewStartDateChanged
ResponseFinishedInterviewEndDateChanged
DurationInterviewDurationChanged
StatusInterviewStateChanged
ResponseLanguageInterviewLanguageChanged
{member field}member.{member field}ChangedTo avoid conflicts between survey variables and question variables the „member.“ prefix has been introduced.
{custom variable}custom.{custom variable}ChangedTo avoid conflicts between question, member and custom variables the „custom.“ prefix has been introduced.
UserAgentRemovedThe unstructured and inhomogeneous field has been removed in favor of the individual structured fields
BrowserLanguageAdded
BrowserNameAdded
BrowserVersionAdded
BrowserWindowSize Added
EncodingAdded
OperatingSystemNameAdded
OperatingSystemVersionAdded
ScreenColorsAdded
ScreenResolutionAdded
DevicePixelRatioAdded
TimezoneOffsetAdded

These naming changes are resolving the issues of Classic which were related to variable conflicts and ambiguity. This mapping table shall help with the API migration from Classic to NG without try / fail iterations.

Additional to the mentioned changed also the license model changed. If you are currently in the Essential license model you are no longer entitled to use the API. In this case please contact Sales to get an appropriate license.

Updated on Februar 15, 2021

Was this article helpful?

Related Articles