Types and enums

Types

ISO 8601 dates

All dates are referenced to UTC, and specified according to ISO 8601.

2016-09-27T15:38:26Z


ISO 639-3 language codes

All languages are specified according to ISO 639-3.


SMS sender

Maximum of 11 characters. Only a-z, A-Z and 0-9 allowed.


SMS recipient

Maximum of 15 digits, formatted with the country code first, i.e. 46735123456

Enums

DispatchType


                    

SendoutLogic


                    

LabelType


                    

RetentionRuleAction


                    

RetentionRuleStatus


                    

RetentionRuleScope


                    

Classes

Answer


AnswerSet


BackgroundDataLabel


BackgroundDataOption


Block


Category


Dispatch


Question


QuestionItem


QuestionItemAlternative


Respondent


RespondentRequest


Sendout


SendoutRetention

A retention action that has been applied to a Sendout: that personal data was removed from it, when that last happened, and how many respondent entries have been removed in total. A Sendout carries one entry per RetentionRuleAction, and no entries at all when no retention action has ever been applied to it.

Available from API version 1.5.


Survey


User