SchoolAide
Help Center
Reference
Reference · Updated Mar 27, 2026

Field Reference — Service Form

1 min read 980 views

Field Reference — Service Form

This reference covers every field in the Create Service and Edit Service forms.

UI Label Backend Variable Type Required Validation Notes
Service Name name string Yes max:100 Display name shown to visitors
Code code string Yes max:10, /^[A-Z0-9]+$/, unique per campus Auto-uppercased; used as ticket display prefix
Office office_id ULID Yes exists:offices (tenant-scoped) Also sets campus_id automatically
Category category string Yes in: enrollment, records, payment, assessment, releasing, general Used for grouping and filtering
Description description string No max:500 Shown to visitors on queue join page
Estimated Duration (min) estimated_duration_minutes int Yes 1–480 Used for wait time estimation
SLA Wait (min) sla_wait_minutes int No 1–120 Target max wait time for SLA Compliance report
Priority Enabled priority_enabled bool If false, all visitors treated as Normal priority regardless of declared type
Visitor Type visitor_type string Yes in: any, student, visitor Restricts who can join this service
Display Prefix display_prefix string No max:10 Prefix shown before ticket number (e.g., "REG")
Ticket Format ticket_format string No max:50 Custom number format template
Sort Order sort_order int min:0 Display order in the service list

Was this article helpful?

Let us know so we can improve our documentation.

Related articles