Hantera enkäter

Läs en samling enkät

Endpoint: GET surveys Endpoint: GET surveys/pinned

Denna slutpunkt ger dig en samling av dina undersökningar, eller bara de fästade undersökningarna. Se definitionen av datatyp nedan.

Läs en enskild enkät

Endpoint: GET surveys/{surveyId}

Denna slutpunkt ger dig en enda undersökning.

Uppdatera en enkät

Endpoint: PUT surveys/{surveyId}

Med dessa slutpunkter kan du uppdatera en undersökning och ändra lagrad data. Allt utom frågor ersätts av de nya uppgifterna.

Skapa en enkät

Endpoint: POST surveys

This endpoint allows you to create a new survey.

Radera enkät

Endpoint: DELETE surveys/{surveyId}

Denna slutpunkt låter dig skapa en ny enkät.

Data-typ

{
  "id": "615d9900792a81c7e32841ee",
  "name": "Awesome Survey",
  "header": "Enkät",
  "showQuestionHeader": true,
  "textAlignment": "Left",
  "backgroundColor": "#f7f7f7",
  "textColor": "#111",
  "buttonColor": "#89b642",
  "logotype": null,
  "backgroundImage": null,
  "useDisclaimer": false,
  "customDisclaimer": null,
  "disclaimerLink": null,
  "customEnding": null,
  "endingLink": null,
  "multipleLanguageSupport": false,
  "supportedLanguages": [
    "en-US"
  ],
  "baseLanguage": "sv-SE",
  "anonymousAnswers": false,
  "endDate": null,
  "pinned": false,
  "lastModified": "2021-10-06T12:56:30.854Z",
  "questions": [
    {
      "type": "Essay",
      "id": "5f9029d4d60d0f12d4db4e68",
      "title": "Frågetitel",
      "subtitle": "",
      "required": false,
      "commentable": false,
      "order": 1,
      "condition": null,
      "maxWords": 100,
      "rows": 4,
      "columns": 30,
      "translations": {
        "en-US": {
          "title": "Question title"
        }
      }
    }
  ],
  "translations": {
    "en-US": {
      "header": "Survey"
    }
  }
}

id

Enkätens ID, som används för att referera till den.

name

Enkätens namn

Enkätens rubrik. Visas för deltagarna istället för namnet.

showQuestionHeader

Om rubrikraden ska visas för deltagaren. Den består av rubriken och frågans framsteg etc. Standardinställningen är false.

textAlignment

Justeringen av textinnehållet i undersökningen. Giltiga värden är Left, Center, Right och Justified. Standardinställning till left.

backgroundColor

Färgen (i hex) som används för enkätens bakgrund. Som standard är #f7f7f7.

textColor

Färgen (i hex) som används för enkätens text. Som standard är #111.

buttonColor

Färgen (i hex) som används för enkäten knappar. Som standard är #89b642.

logotype

En URL till logotypen som används i enkäten. Frivillig.

backgroundImage

En URL till bakgrundsbilden som används i enkäten. Frivillig.

useDisclaimer

Om man ska visa en välkomnande friskrivningstext i början av enkäten.

customDisclaimer

En anpassad friskrivningstext att visa, om ingen är inställd kommer en allmän standardtext att visas. Standard är null.

En länk att visa efter friskrivningstexten. Kan användas för integritetspolicyer etc. Den består antingen av en URL att länka eller av två delar åtskilda av ett rör (|), där den första är texten som ska visas och den andra är URL:en som ska länkas. Standard är null.

customEnding

En anpassad sluttext att visa efter att enkäten har skickats in. Standard är null.

En länk att visa efter sluttexten. Den består antingen av en URL att länka eller av två delar åtskilda av ett rör (|), där den första är texten som ska visas och den andra är URL:en som ska länkas. Standard är null.

multipleLanguageSupport

Om man ska stödja flera språk för deltagarna att välja mellan när de svarar. Standardinställningen är false.

supportedLanguages

En lista över språk att stödja förutom basspråket. Krävs om stöd för flera språk är aktivt. Standard till ingen.

baseLanguage

Undersökningens basspråk. Språket för allt som inte är översatt och språket som visas vid redigering av undersökningen och i rapporter.

anonymousAnswers

Om deltagardata ska raderas efter att de har skickat in sina svar, vilket gör svaren anonyma.

endDate

Ett datum efter vilket undersökningen inte accepterar några nya svar. Valfritt, standardvärdet är null.

pinned

Om undersökningen är fäst.

lastModified

Tidsstämpel för senaste ändring av undersökningen.

questions

En samling av frågorna i undersökningen. Mer om dessa i Hantera frågor.

translations

En ordbok med nycklar för varje språk som stöds förutom basspråket. Värdena är ordböcker med nycklar som andra undersökningsegenskaper och värden som deras översatta värden. Exemplet översätter enkäthuvudet från basspråket sv-SE till ett annat värde om deltagaren väljer en-US när han svarar.