Portals

Intuitive web portals system that acts as an easily accessible hub for your forms. Use this hub to seamlessly share individual forms or groups of forms with designated people inside or outside of your organization.

Models

Portal

Name	Type	Required	Read-only
id	int	yes	no
name	string	yes	no
description	string?	no	no
avatar	string	no	yes
created	string(Y-m-d H:i:s)	no	yes
timezone	string	yes	yes
participantCount	int	yes	yes
portalForms	PortalForm[]	no	no
portalUsers	PortalUser[]	no	no

PortalForm

Name	Type	Required	Read-only
id	int	yes	no
formId	int	yes	no
name	string	yes	no
deadline	oneOf(null, PortalFormDeadlineDaily, PortalFormDeadlineWeekly, PortalFormDeadlineMonthly)`	yes	no
completedUserCount	int	no	yes
description	string?	no	no
formUrl	string	yes	yes
notifyUsers	bool	yes	no
usersPerformance	PortalUserPerformance[]	no	yes

PortalUser

Name	Type	Required	Read-only
id	int	yes	no
avatarUrl	string	yes	yes
email	string	yes	no
name	string	yes	no
type	string(oneOf("internal", "external"))	yes	yes

PortalUserPerformance

Name	Type	Required	Read-only
id	int	yes	yes
formCompletionDate	string(Y-m-d H:i:s)	no	yes
lastSubmissionId	int	no	yes

Deadline models:

PortalFormDeadlineDaily

Name	Type	Required	Read-only
frequency	string(daily)	yes	no
dueTime	string(24h format (ex: 20:00:00)	yes	no
earlyReminderHours	int?	no	no

PortalFormDeadlineDate

Name	Type	Required	Read-only
frequency	string(date)	yes	no
dueDate	string(Y-m-d H:i:s format)	yes	no
earlyReminderHours	int?	no	no
earlyReminderDays	int?	no	no

PortalFormDeadlineMonthly

Name	Type	Required	Read-only
frequency	string(monthly)	yes	no
dueDay	string(oneOf("1",, "15", "last")) for corresponding: "first-of-month", "middle-of-month", "end-of-month" values	yes	no
dueDate	string(Y-m-d H:i:s format)	yes	no
earlyReminderHours	int?	no	no
earlyReminderDays	int?	no	no

PortalFormDeadlineWeekly

Name	Type	Required	Read-only
frequency	string(weekly)	yes	no
dueDay	string(date format=EEE, ex: Mon/Tue/etc)	yes	no
dueDate	string(Y-m-d H:i:s format)	yes	no
earlyReminderHours	int?	no	no
earlyReminderDays	int?	no	no