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

NameTypeRequiredRead-only
idintyesno
namestringyesno
descriptionstring?nono
avatarstringnoyes
createdstring(Y-m-d H:i:s)noyes
timezonestringyesyes
participantCountintyesyes
portalFormsPortalForm[]nono
portalUsersPortalUser[]nono

PortalForm

NameTypeRequiredRead-only
idintyesno
formIdintyesno
namestringyesno
deadlineoneOf(null, PortalFormDeadlineDaily, PortalFormDeadlineWeekly, PortalFormDeadlineMonthly)`yesno
completedUserCountintnoyes
descriptionstring?nono
formUrlstringyesyes
notifyUsersboolyesno
usersPerformancePortalUserPerformance[]noyes

PortalUser

NameTypeRequiredRead-only
idintyesno
avatarUrlstringyesyes
emailstringyesno
namestringyesno
typestring(oneOf("internal", "external"))yesyes

PortalUserPerformance

NameTypeRequiredRead-only
idintyesyes
formCompletionDatestring(Y-m-d H:i:s)noyes
lastSubmissionIdintnoyes

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

NameTypeRequiredRead-only
frequencystring(date)yesno
dueDatestring(Y-m-d H:i:s format)yesno
earlyReminderHoursint?nono
earlyReminderDaysint?nono

PortalFormDeadlineMonthly

NameTypeRequiredRead-only
frequencystring(monthly)yesno
dueDaystring(oneOf("1",, "15", "last")) for corresponding: "first-of-month", "middle-of-month", "end-of-month" valuesyesno
dueDatestring(Y-m-d H:i:s format)yesno
earlyReminderHoursint?nono
earlyReminderDaysint?nono

PortalFormDeadlineWeekly

NameTypeRequiredRead-only
frequencystring(weekly)yesno
dueDaystring(date format=EEE, ex: Mon/Tue/etc)yesno
dueDatestring(Y-m-d H:i:s format)yesno
earlyReminderHoursint?nono
earlyReminderDaysint?nono