Survey Definition Response - data model discrepancies | XM Community
Skip to main content

HI, below are the all data model discrepancies I have found for REST endpoint: 

https://fra1.qualtrics.com/API/v3/survey-definitions/{surveyId}/versions/{versionId}.

Why these are not documented anywhere? Should I ignore them during data deserialization and validation?

 

In general there are at least two issues:

  • some properties are not documented
  • some of them are null but according to official documentation, they should not

 

Survey Definition Response:

  • Result -> LastAccessed can be null but is required according to documentation but is required according to documentation
  • SurveyOptions-> NewScoring - is missing in documentation in documentation
  • SurveyOptions-> CustomStyles - is an object not string
  • SurveyOptions-> ShowExportTags - is missing in documentation in documentation
  • SurveyOptions-> ConfirmStart - is missing in documentation
  • SurveyOptions-> AutoConfirmStart - is missing in documentation
  • SurveyOptions-> RelevantID - is missing in documentation
  • SurveyOptions-> RelevantIDLockoutPeriod - is missing in documentation
  • SurveyOptions-> UseCustomSurveyLinkCompletedMessage - is missing in documentation
  • SurveyOptions-> SurveyLinkCompletedMessage - is missing in documentation
  • SurveyOptions-> SurveyLinkCompletedMessageLibrary - is missing in documentation
  • SurveyOptions-> EOSMessageLibrary - is missing in documentation
  • SurveyOptions-> PartialDeletion - is missing in documentation
  • SurveyOptions-> SurveyCreationDate - is missing in documentation
  • SurveyOptions-> ProtectSelectionIds - is missing in documentation
  • SurveyOptions-> MetaDataTranslations - is missing in documentation
  • SurveyOptions-> ActiveResponseSet - is missing in documentation
  • Flow -> ID is missing in documentation
  • Flow -> Description is missing in documentation
  • Flow -> EndingType is missing in documentation
  • Flow -> Autofill is missing in documentation
  • Flow -> BranchLogic is missing in documentation
  • Flow -> EmbeddedData is missing in documentation
  • Flow -> SSOOptions can be null but is required according to documentation
  • Flow -> Options can be null but is required according to documentation
  • Flow -> Options -> Advanced is missing in documentation
  • Flow -> Options -> SurveyTermination is missing in documentation
  • Flow -> Options -> EOSRedirectURL is missing in documentation
  • Flow -> Options -> Screenout is missing in documentation
  • Flow -> Options -> CountQuotas is missing in documentation
  • Flow -> Options -> AnonymizeResponse is missing in documentation
  • Flow -> Options -> EmailThankYou is missing in documentation
  • Flow -> Options -> IgnoreResponse is missing in documentation
  • Flow -> Options -> ScreenOutName is missing in documentation
  • Flow -> Options -> ResponseFlag is missing in documentation
  • SurveyFlow -> Flow -> FieldData can be null but is required according to documentation
  • SurveyFlow -> Flow -> FilterDataFields can be null but is required according to documentation
  • ProjectInfo -> SchemaVersion can be null but is required according to documentation but is required according to documentation
  • VersionMetadata -> is missing in documentation
  • Quotas -> is missing in documentation
  • QuotaGroups -> is missing in documentation
  • QuotaGroupOrder -> is missing in documentation
  • ScreenOut -> is missing in documentation
Be the first to reply!

Leave a Reply