citric.types¶

Citric Python types.

Attributes¶

Result

Classes¶

`FileUploadResult`	File upload result.
`GroupProperties`	Group properties.
`LanguageProperties`	Language properties.
`OperationStatus`	Delete language result.
`QuestionsListElement`	List questions result.
`QuestionProperties`	Question properties result.
`QuotaListElement`	List quotas result.
`QuotaProperties`	Quota properties result.
`RPCResponse`	RPC response payload.
`SetQuotaPropertiesResult`	Set quota properties result.
`SurveyListElement`	List surveys result.
`SurveyProperties`	Survey properties result.
`CPDBParticipantImportResult`	CPDB participant import result.
`SurveyUserActivationSettings`	User settings for survey activation.
`ExportAdditionalOptions`	Export formatting options.
`Permission`	Permission.
`UserDetails`	User details.
`QuestionReference`	Uploaded file question reference.
`FileMetadata`	Uploaded file metadata.
`EncodedFile`	A file uploaded to a survey response.
`ReadableFile`	A file uploaded to a survey response.
`SurveySummary`	Survey summary.
`ParticipantInfo`	Participant info.
`ParticipantListElement`	Participant list element.

Module Contents¶

type citric.types.Result = Any[source]¶

class citric.types.FileUploadResult[source]¶

Bases: TypedDict

File upload result.

success: bool[source]¶: Whether the file was uploaded successfully.

size: int[source]¶: The size of the file.

name: str[source]¶: The name of the file.

ext: str[source]¶: The extension of the file.

filename: str[source]¶: The filename of the file.

msg: str[source]¶: The message of the file.

class citric.types.GroupProperties[source]¶

Bases: TypedDict

Group properties.

gid: int[source]¶: The group ID.

sid: int[source]¶: The survey ID.

group_order: int[source]¶: The group order.

randomization_group: str[source]¶: The randomization group.

grelevance: str[source]¶: The group relevance.

group_name: str[source]¶: The group name.

description: str[source]¶: The group description.

class citric.types.LanguageProperties[source]¶

Bases: TypedDict

Language properties.

surveyls_survey_id: int[source]¶: The survey ID.

surveyls_language: str[source]¶: The language code.

surveyls_title: str[source]¶: The survey title.

surveyls_description: str | None[source]¶: The survey description.

surveyls_welcometext: str | None[source]¶: The survey welcome text.

surveyls_endtext: str | None[source]¶: The survey end text.

surveyls_policy_notice: str | None[source]¶: The survey policy notice.

surveyls_policy_error: str | None[source]¶: The survey policy error.

surveyls_policy_notice_label: str | None[source]¶: The survey policy notice label.

surveyls_url: str[source]¶: The survey URL.

surveyls_urldescription: str | None[source]¶: The survey URL description.

surveyls_alias: str | None[source]¶: The survey alias.

surveyls_email_invite_subj: str[source]¶: The survey email invite subject.

surveyls_email_invite: str[source]¶: The survey email invite.

surveyls_email_remind_subj: str[source]¶: The survey email remind subject.

surveyls_email_remind: str[source]¶: The survey email remind.

surveyls_email_register_subj: str[source]¶: The survey email register subject.

surveyls_email_register: str[source]¶: The survey email register.

surveyls_email_confirm_subj: str[source]¶: The survey email confirm subject.

surveyls_email_confirm: str[source]¶: The survey email confirm.

surveyls_dateformat: int[source]¶: The survey date format.

surveyls_numberformat: int[source]¶: The survey number format.

surveyls_attributecaptions: str | None[source]¶: The survey attribute captions.

email_admin_notification_subj: str[source]¶: The email admin notification subject.

email_admin_notification: str[source]¶: The email admin notification.

email_admin_responses_subj: str[source]¶: The email admin responses subject.

email_admin_responses: str[source]¶: The email admin responses.

attachments: str | None[source]¶: The attachments.

class citric.types.OperationStatus[source]¶

Bases: TypedDict

Delete language result.

status: str[source]¶: The status of the operation.

class citric.types.QuestionsListElement[source]¶

Bases: TypedDict

List questions result.

id: int[source]¶: The question ID.

qid: int[source]¶: The question ID.

parent_qid: int[source]¶: The parent question ID.

gid: int[source]¶: The group ID.

sid: int[source]¶: The survey ID.

question: str[source]¶: The question.

help: str[source]¶: The question help text.

language: str[source]¶: The question language.

type: str[source]¶: The question type.

title: str[source]¶: The question title.

preg: str[source]¶: The question preg.

other: YesNo[source]¶: Whether the question has an “other” option.

mandatory: YesNo[source]¶: Whether the question is mandatory.

encrypted: YesNo[source]¶: Whether the question is encrypted.

question_order: int[source]¶: The question order.

scale_id: int[source]¶: The question scale ID.

same_default: int[source]¶: The question same default.

relevance: str[source]¶: The question relevance.

question_theme_name: str[source]¶: The question theme name.

modulename: str[source]¶: The question module name.

same_script: int[source]¶: The question same script.

class citric.types.QuestionProperties[source]¶

Bases: TypedDict

Question properties result.

qid: int[source]¶: The question ID.

parent_qid: int[source]¶: The parent question ID.

gid: int[source]¶: The group ID.

sid: int[source]¶: The survey ID.

question: str[source]¶: The question text in the survey language.

help: str[source]¶: The question help text in the survey language.

script: str[source]¶: The question script.

questionl10ns: dict[str, Any][source]¶: The question language-specific attributes.

type: str[source]¶: The question type.

title: str[source]¶: The question title.

preg: str[source]¶: The question preg.

other: YesNo[source]¶: Whether the question has an “other” option.

mandatory: YesNo[source]¶: Whether the question is mandatory.

encrypted: YesNo[source]¶: Whether the question is encrypted.

question_order: int[source]¶: The question order.

scale_id: int[source]¶: The question scale ID.

same_default: int[source]¶: The question same default.

relevance: str[source]¶: The question relevance.

question_theme_name: str[source]¶: The question theme name.

modulename: str[source]¶: The question module name.

same_script: int[source]¶: The question same script.

available_answers: Any[source]¶: The available answers.

answer_options: Any[source]¶: The answer options.

subquestions: Any[source]¶: The subquestions.

default_values: Any[source]¶: The default values.

attributes: dict[str, Any][source]¶: The question attributes.

attributes_lang: dict[str, Any][source]¶: The question attributes language.

class citric.types.QuotaListElement[source]¶

Bases: TypedDict

List quotas result.

id: int[source]¶: The quota ID.

name: str[source]¶: The quota name.

action: int[source]¶: The quota limit.

limit: int[source]¶: Whether the quota is active.

active: int[source]¶: The quota action.

autoload_url: int[source]¶: Whether the quota autoload URL is active.

class citric.types.QuotaProperties[source]¶

Bases: TypedDict

Quota properties result.

id: int[source]¶: The quota ID.

sid: int[source]¶: The survey ID.

name: str[source]¶: The quota name.

qlimit: int[source]¶: The quota limit.

action: int[source]¶: The quota action.

active: int[source]¶: Whether the quota is active.

autoload_url: int[source]¶: Whether the quota autoload URL is active.

completeCount: int[source]¶: Count of completed interviews for this quota.

quotals_message: str[source]¶: Quota message for this language.

quotals_url: str[source]¶: Quota end-URL for this language.

quotals_urldescrip: str[source]¶: Quota end-URL description for this language.

class citric.types.RPCResponse[source]¶

Bases: TypedDict

RPC response payload.

id: int[source]¶: The ID of the request.

result: Result[source]¶: The result of the RPC call.

error: str | None[source]¶: The error message of the RPC call.

class citric.types.SetQuotaPropertiesResult[source]¶

Bases: TypedDict

Set quota properties result.

success: bool[source]¶: Whether the operation was successful.

message: QuotaProperties[source]¶: The quota properties.

class citric.types.SurveyListElement[source]¶

Bases: TypedDict

List surveys result.

sid: int[source]¶: The survey ID.

gsid: int[source]¶: The survey group ID.

Warning

This attribute is only supported in LimeSurvey 6.10.0 and above.

surveyls_title: str[source]¶: The survey title.

startdate: str[source]¶: The survey start date.

expires: str[source]¶: The survey expiration date.

active: YesNo[source]¶: Whether the survey is active.

class citric.types.SurveyProperties[source]¶

Bases: TypedDict

Survey properties result.

sid: int[source]¶: The survey ID.

owner_id: int[source]¶: The survey owner ID.

gsid: int[source]¶: The survey group ID.

active: YesNo[source]¶: Whether the survey is active.

expires: str | None[source]¶: The survey expiration date.

startdate: str | None[source]¶: The survey start date.

anonymized: YesNo[source]¶: Whether the survey is anonymized.

faxto: str[source]¶: The survey fax number.

format: citric.enums.NewSurveyType[source]¶: The survey format.

savetiming: YesNo[source]¶: Whether the survey saves timing.

template: str[source]¶: The survey template.

datesstamp: YesNo[source]¶: Whether the survey stamps dates.

usecookie: YesNo[source]¶: Whether the survey uses cookies.

allowregister: YesNo[source]¶: Whether the survey allows registration.

allowsave: YesNo[source]¶: Whether the survey allows saving.

autonumber_start: int[source]¶: The survey autonumber start.

autoredirect: YesNo[source]¶: Whether the survey auto-redirects.

allowprev: YesNo[source]¶: Whether the survey allows previous.

printanswers: YesNo[source]¶: Whether the survey prints answers.

ipaddr: YesNo[source]¶: Whether the survey uses IP addresses.

ipanonymize: YesNo[source]¶: Whether the survey anonymizes IP addresses.

refurl: YesNo[source]¶: Whether the survey uses referrer URLs.

datecreated: str[source]¶: The survey creation date.

showsurveypolicynotice: YesNo[source]¶: Whether the survey shows policy notice.

publicstatistics: YesNo[source]¶: Whether the survey is public.

publicgraphs: YesNo[source]¶: Whether the survey graphs are public.

listpublic: YesNo[source]¶: Whether the survey is listed publicly.

tokenanswerspersistence: YesNo[source]¶: Whether the survey token answers persist.

assessments: YesNo[source]¶: Whether the survey uses assessments.

usecaptcha: YesNo[source]¶: Whether the survey uses CAPTCHA.

usetokens: YesNo[source]¶: Whether the survey uses tokens.

attributedescriptions: str | None[source]¶: The survey attribute descriptions.

tokenlength: int[source]¶: The survey token length.

alloweditaftercompletion: YesNo[source]¶: Whether the survey allows editing after completion.

googleanalyticsstyle: str | None[source]¶: Whether the survey uses Google Analytics style.

googleanalyticsapikey: str | None[source]¶: The survey Google Analytics API key.

tokenencryptionoptions: str[source]¶: The survey token encryption options.

showxquestions: YesNo[source]¶: Whether the survey shows x questions.

showgroupinfo: YesNo[source]¶: Whether the survey shows group info.

shownoanswer: YesNo[source]¶: Whether the survey shows no answer.

showqnumcode: YesNo[source]¶: Whether the survey shows question number code.

showwelcome: YesNo[source]¶: Whether the survey shows welcome.

showprogress: YesNo[source]¶: Whether the survey shows progress.

questionindex: int[source]¶: Index of the survey question.

navigationdelay: int[source]¶: The survey navigation delay.

nokeyboard: YesNo[source]¶: Whether the survey should allow keyboard input.

bouncetime: int | None[source]¶: The survey bounce time.

bounceprocessing: YesNo[source]¶: Whether the survey bounces are processed.

bounceaccounttype: str | None[source]¶: The survey bounce account type.

bounceaccounthost: str | None[source]¶: The survey bounce account host.

bounceaccountpass: str | None[source]¶: The survey bounce account password.

bounceaccountencryption: str | None[source]¶: The survey bounce account encryption.

bounceaccountuser: str | None[source]¶: The survey bounce account user.

htmlemail: YesNo[source]¶: Whether the survey emails are HTML.

sendconfirmation: YesNo[source]¶: Whether the survey sends confirmation.

bounce_email: str[source]¶: The survey bounce email.

emailresponseto: str | None[source]¶: The survey email response to.

emailnotificationto: str | None[source]¶: The survey email notification to.

admin: str[source]¶: The survey admin.

admin_email: str[source]¶: The survey admin email.

language: str[source]¶: The survey language.

additional_languages: str[source]¶: The survey additional languages.

class citric.types.CPDBParticipantImportResult[source]¶

Bases: TypedDict

CPDB participant import result.

ImportCount: int[source]¶: The number of participants imported.

UpdateCount: int[source]¶: The number of participants updated.

class citric.types.SurveyUserActivationSettings[source]¶

Bases: TypedDict

User settings for survey activation.

anonymized: bool[source]¶: Whether the survey is anonymized.

datestamp: bool[source]¶: Whether the survey records dates.

ipaddr: bool[source]¶: Whether the survey records IP addresses.

ipanonymize: bool[source]¶: Whether the survey anonymizes IP addresses.

refurl: bool[source]¶: Whether the survey records referrer URLs.

savetimings: bool[source]¶: Whether the survey saves response timings.

class citric.types.ExportAdditionalOptions[source]¶

Bases: TypedDict

Export formatting options.

convertY: bool[source]¶

Convert Y response values.

If response_type is short, then this indicates that Y responses should be converted to another value that is specified by yValue.

yValue: Any[source]¶: The value to convert Y responses to.

convertN: bool[source]¶

Convert N response values.

If response_type is short, then this indicates that N responses should be converted to another value that is specified by nValue.

nValue: Any[source]¶: The value to convert N responses to.

headerSpacesToUnderscores: bool[source]¶: Indicates whether to convert spaces in question headers to underscores.

headingTextLength: int[source]¶: Indicates whether to ellipsize each text part to.

useEMCode: bool[source]¶: Indicates whether to use ExpressionScript Engine code.

headCodeTextSeparator: str[source]¶: What is the characters to separate code and text.

csvFieldSeparator: str[source]¶: What is the character to separate CSV fields.

csvMaskEquations: bool[source]¶: Mask CSV/Excel equation fields to prevent CSV injection attacks.

stripHtmlCode: Literal['1', '0'][source]¶

Strip HTML code from the responses.

1: Strip HTML code.
0: No stripping.

class citric.types.Permission[source]¶

Bases: TypedDict

Permission.

id: int[source]¶: The permission ID.

entity: str[source]¶: The permission entity.

entity_id: int[source]¶: The permission entity ID.

permission: str[source]¶: The permission.

create_p: int[source]¶: Whether the permission can create.

read_p: int[source]¶: Whether the permission can read.

update_p: int[source]¶: Whether the permission can update.

class citric.types.UserDetails[source]¶

Bases: TypedDict

User details.

uid: int[source]¶: The user ID.

users_name: str[source]¶: The user name.

full_name: str[source]¶: The user full name.

parent_id: int[source]¶: The user parent ID.

lang: str[source]¶: The user preferred language.

email: str[source]¶: The user email.

htmleditormode: str[source]¶: The user preferred HTML editor mode.

templateeditormode: str[source]¶: The user preferred template editor mode.

questionselectormode: str[source]¶: The user preferred question type selector.

one_time_pw: str[source]¶: The user one-time password.

dateformat: int[source]¶: The user date format.

created: str[source]¶: The user creation date.

modified: str[source]¶: The user modification date.

validation_key: str[source]¶: The user validation key.

validation_key_expiration: str[source]¶: The user validation key expiration.

last_forgot_email_password: str[source]¶: The user last forgot email password.

permissions: list[Permission][source]¶: The user permissions.

last_login: str[source]¶: The user last login.

user_status: citric.enums.UserStatus[source]¶: The user status.

class citric.types.QuestionReference[source]¶

Bases: TypedDict

Uploaded file question reference.

title: str[source]¶: Question title.

qid: int[source]¶: Question ID.

class citric.types.FileMetadata[source]¶

Bases: FileUploadResult

Uploaded file metadata.

question: QuestionReference[source]¶: Reference to the question that the file was uploaded to.

index: int[source]¶: File index.

class citric.types.EncodedFile[source]¶

Bases: TypedDict

A file uploaded to a survey response.

meta: FileMetadata[source]¶: Metadata about the file.

content: str[source]¶: File content as base64 encoded string.

class citric.types.ReadableFile[source]¶

Bases: TypedDict

A file uploaded to a survey response.

meta: FileMetadata[source]¶: Metadata about the file.

content: io.BytesIO[source]¶: File content as io.BytesIO.

class citric.types.SurveySummary[source]¶

Bases: TypedDict

Survey summary.

token_count: int[source]¶: The number of tokens.

token_invalid: int[source]¶: The number of invalid tokens.

token_sent: int[source]¶: The number of tokens sent.

token_opted_out: int[source]¶: The number of tokens opted out.

token_completed: int[source]¶: The number of tokens completed.

token_screenout: int[source]¶: The number of tokens screenout.

completed_responses: int[source]¶: The number of completed responses.

incomplete_responses: int[source]¶: The number of incomplete responses.

full_responses: int[source]¶: The number of full responses.

class citric.types.ParticipantInfo[source]¶

Bases: TypedDict

Participant info.

firstname: str[source]¶: The participant first name.

lastname: str[source]¶: The participant last name.

email: str[source]¶: The participant email.

class citric.types.ParticipantListElement[source]¶

Bases: TypedDict

Participant list element.

tid: Required[int][source]¶: The participant access code ID.

token: Required[str][source]¶: The participant access code.

participant_info: Required[ParticipantInfo][source]¶: The participant info.

emailstatus: str[source]¶: The participant email status.

language: str[source]¶: The participant language.

blacklisted: YesNo[source]¶: Whether the participant is blacklisted.

sent: YesNo[source]¶: Whether the participant invitation was sent.

remindersent: YesNo[source]¶: Whether the participant reminder was sent.

remindercount: int[source]¶: The total number of reminders sent.

completed: YesNo[source]¶: Whether the participant completed the survey.

usesleft: int[source]¶: How many uses left to fill questionnaire for this participant.

validfrom: str[source]¶: Start date of the participant access code.

validuntil: str[source]¶: End date of the participant access code.