GRPC Protobuf Documentation

Documentation for GRPC Protobuf files.

codegen/audit/redacted.proto

File-level Extensions

Extension	Type	Base	Number	Description
`redacted`	bool	.google.protobuf.FieldOptions	51006

codegen/dbscanner/dbscanner.proto

codegen.dbscanner.MessageOptions

Field	Type	Label
`enabled`	bool
`not_json`	bool	optional
`partial`	bool	optional

File-level Extensions

Extension	Type	Base	Number	Description
`dbscanner`	MessageOptions	.google.protobuf.MessageOptions	51004

codegen/itemslen/itemslen.proto

File-level Extensions

Extension	Type	Base	Number	Description
`enabled`	bool	.google.protobuf.FieldOptions	51001

codegen/sanitizer/sanitizer.proto

codegen.sanitizer.FieldOptions

Field	Type	Label	Description
`enabled`	bool		Default false
`method`	string	optional
`strip_html_tags`	bool	optional	Default false
`tiptap_json`	bool	optional	Default false
`max_bytes`	uint32	optional

File-level Extensions

Extension	Type	Base	Number	Description
`sanitizer`	FieldOptions	.google.protobuf.FieldOptions	51003

resources/timestamp/timestamp.proto

resources.timestamp.Timestamp

Timestamp for storage messages. We've defined a new local type wrapper of google.protobuf.Timestamp so we can implement sql.Scanner and sql.Valuer interfaces. See: https://golang.org/pkg/database/sql/#Scanner https://golang.org/pkg/database/sql/driver/#Valuer

Field	Type	Label	Description
`timestamp`	google.protobuf.Timestamp

resources/permissions/attributes/attributes.proto

resources.permissions.attributes.AttributeValues

Field	Type	Label	Description
`string_list`	StringList
`job_list`	StringList
`job_grade_list`	JobGradeList

resources.permissions.attributes.JobGradeList

Field	Type	Label
`fine_grained`	bool
`jobs`	JobGradeList.JobsEntry	repeated
`grades`	JobGradeList.GradesEntry	repeated

resources.permissions.attributes.JobGradeList.GradesEntry

Field	Type	Label	Description
`key`	string
`value`	JobGrades

resources.permissions.attributes.JobGradeList.JobsEntry

Field	Type	Label	Description
`key`	string
`value`	int32

resources.permissions.attributes.JobGrades

Field	Type	Label	Description
`grades`	int32	repeated

resources.permissions.attributes.RoleAttribute

Field	Type	Label
`role_id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`attr_id`	int64
`permission_id`	int64
`namespace`	string
`service`	string
`name`	string
`key`	string
`type`	string
`valid_values`	AttributeValues
`value`	AttributeValues
`max_values`	AttributeValues	optional

resources.permissions.attributes.StringList

Field	Type	Label	Description
`strings`	string	repeated

resources.permissions.attributes.AttributeType

Name	Number	Description
`ATTRIBUTE_TYPE_UNSPECIFIED`	0
`ATTRIBUTE_TYPE_STRING_LIST`	1
`ATTRIBUTE_TYPE_JOB_LIST`	2
`ATTRIBUTE_TYPE_JOB_GRADE_LIST`	3

codegen/perms/perms.proto

codegen.perms.AdditionalServicePerm

Field	Type	Label
`name`	string
`order`	int32
`attrs`	Attr	repeated

codegen.perms.Attr

Field	Type	Label
`key`	string
`value`	string
`type`	resources.permissions.attributes.AttributeType
`valid_string_list`	string	repeated

codegen.perms.PermsOptions

Field	Type	Label
`enabled`	bool
`namespace`	string	optional
`service`	string	optional
`name`	string	optional
`names`	string	repeated
`order`	int32
`attrs`	Attr	repeated
`internal`	bool

codegen.perms.ServiceOptions

Field	Type	Label
`order`	int32
`icon`	string	optional
`namespace`	string	optional
`service`	string	optional
`additional_perms`	AdditionalServicePerm	repeated

File-level Extensions

Extension	Type	Base	Number	Description
`perms`	PermsOptions	.google.protobuf.MethodOptions	51002
`perms_svc`	ServiceOptions	.google.protobuf.ServiceOptions	51005

resources/users/short/user.proto

resources.users.short.UserShort

Field	Type	Label
`user_id`	int32
`job`	string
`job_label`	string	optional
`job_grade`	int32
`job_grade_label`	string	optional
`firstname`	string
`lastname`	string
`dateofbirth`	string
`phone_number`	string	optional
`profile_picture_file_id`	int64	optional
`profile_picture`	string	optional

resources/access/access.proto

resources.access.Access

Field	Type	Label
`jobs`	JobAccess	repeated
`users`	UserAccess	repeated
`qualifications`	QualificationAccess	repeated

resources.access.JobAccess

Field	Type	Label
`id`	int64
`target_id`	int64
`job`	string
`job_label`	string	optional
`minimum_grade`	int32
`job_grade_label`	string	optional
`access`	int32
`required`	bool	optional
`required_access`	int32	optional

resources.access.QualificationAccess

Field	Type	Label
`id`	int64
`target_id`	int64
`qualification_id`	int64
`access`	int32
`required`	bool	optional
`required_access`	int32	optional

resources.access.UserAccess

Field	Type	Label
`id`	int64
`target_id`	int64
`user_id`	int32
`user`	resources.users.short.UserShort	optional
`access`	int32
`required`	bool	optional
`required_access`	int32	optional

resources/accounts/oauth2/oauth2.proto

resources.accounts.oauth2.OAuth2Account

Field	Type	Label
`account_id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`provider_name`	string
`provider`	OAuth2Provider
`external_id`	string
`username`	string
`avatar`	string

resources.accounts.oauth2.OAuth2Provider

Field	Type	Label
`name`	string
`label`	string
`homepage`	string
`icon`	string	optional

resources/citizens/licenses/licenses.proto

resources.citizens.licenses.License

Field	Type	Label	Description
`type`	string
`label`	string

resources.citizens.licenses.Licenses

Field	Type	Label	Description
`user_id`	int32
`licenses`	License	repeated

resources/citizens/labels/labels.proto

resources.citizens.labels.Label

Field	Type	Label	Description
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`job`	string	optional
`sort_order`	int32
`name`	string
`color`	string
`icon`	string	optional
`settings`	Settings	optional
`access`	resources.access.Access	optional
`expires_at`	resources.timestamp.Timestamp	optional	Citizen label assignment data

resources.citizens.labels.Labels

Field	Type	Label	Description
`list`	Label	repeated

resources.citizens.labels.Settings

Field	Type	Label
`requires_expiration`	bool
`min_duration`	google.protobuf.Duration	optional
`max_duration`	google.protobuf.Duration	optional

resources/file/meta.proto

resources.file.FileMeta

Field	Type	Label	Description
`image`	ImageMeta

resources.file.ImageMeta

Field	Type	Label	Description
`width`	int64
`height`	int64

resources/file/file.proto

resources.file.File

Field	Type	Label	Description
`parent_id`	int64	optional
`id`	int64
`file_path`	string
`created_at`	resources.timestamp.Timestamp	optional
`byte_size`	int64		Bytes stored
`content_type`	string
`meta`	FileMeta	optional
`is_dir`	bool

resources/jobs/jobs.proto

resources.jobs.Job

Field	Type	Label
`name`	string
`label`	string
`grades`	JobGrade	repeated

resources.jobs.JobGrade

Field	Type	Label
`job_name`	string	optional
`grade`	int32
`label`	string

resources/users/props/props.proto

resources.users.props.UserProps

Field	Type	Label
`user_id`	int32
`updated_at`	resources.timestamp.Timestamp	optional
`wanted`	bool	optional
`wanted_at`	resources.timestamp.Timestamp	optional
`wanted_till`	resources.timestamp.Timestamp	optional
`job_name`	string	optional
`job`	resources.jobs.Job	optional
`job_grade_number`	int32	optional
`job_grade`	resources.jobs.JobGrade	optional
`traffic_infraction_points`	uint32	optional
`traffic_infraction_points_updated_at`	resources.timestamp.Timestamp	optional
`open_fines`	int64	optional
`blood_type`	string	optional
`mugshot_file_id`	int64	optional
`mugshot`	resources.file.File	optional
`labels`	resources.citizens.labels.Labels	optional
`email`	string	optional

resources/users/user.proto

resources.users.PhoneNumber

Field	Type	Label
`user_id`	int32
`number`	string
`is_primary`	bool
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional

resources.users.User

Field	Type	Label
`user_id`	int32
`identifier`	string
`job`	string
`job_label`	string	optional
`job_grade`	int32
`job_grade_label`	string	optional
`jobs`	UserJob	repeated
`firstname`	string
`lastname`	string
`dateofbirth`	string
`sex`	string	optional
`height`	float	optional
`phone_number`	string	optional
`phone_numbers`	PhoneNumber	repeated
`visum`	int32	optional
`playtime`	int32	optional
`props`	props.UserProps
`licenses`	resources.citizens.licenses.License	repeated
`profile_picture_file_id`	int64	optional
`profile_picture`	string	optional

resources.users.UserJob

Field	Type	Label
`user_id`	int32
`job`	string
`job_label`	string	optional
`grade`	int32
`grade_label`	string	optional
`is_primary`	bool
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional

resources/accounts/accounts.proto

resources.accounts.Account

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`enabled`	bool
`username`	string
`license`	string
`groups`	AccountGroups	optional
`last_char`	int32	optional
`oauth2_accounts`	oauth2.OAuth2Account	repeated

resources.accounts.AccountGroups

Field	Type	Label	Description
`groups`	string	repeated

resources.accounts.Character

Field	Type	Label	Description
`available`	bool
`group`	string
`char`	resources.users.User

resources/audit/audit.proto

resources.audit.AuditEntry

Field	Type	Label	Description
`id`	int64
`created_at`	resources.timestamp.Timestamp
`user_id`	int32	optional
`user`	resources.users.short.UserShort	optional
`user_job`	string
`target_user_id`	int32	optional
`target_user`	resources.users.short.UserShort	optional
`target_user_job`	string	optional
`service`	string		GRPC Service name
`method`	string		GRPC Method name
`action`	EventAction
`result`	EventResult
`meta`	AuditEntryMeta	optional
`data`	string	optional
`account_id`	int64	optional

resources.audit.AuditEntryMeta

Field	Type	Label	Description
`meta`	AuditEntryMeta.MetaEntry	repeated

resources.audit.AuditEntryMeta.MetaEntry

Field	Type	Label	Description
`key`	string
`value`	string

resources.audit.EventAction

Name	Number	Description
`EVENT_ACTION_UNSPECIFIED`	0
`EVENT_ACTION_VIEWED`	2
`EVENT_ACTION_CREATED`	3
`EVENT_ACTION_UPDATED`	4
`EVENT_ACTION_DELETED`	5
`EVENT_ACTION_RESTORED`	6

resources.audit.EventResult

Name	Number	Description
`EVENT_RESULT_UNSPECIFIED`	0
`EVENT_RESULT_SUCCEEDED`	1
`EVENT_RESULT_FAILED`	2
`EVENT_RESULT_ERRORED`	3

resources/calendar/access/access.proto

resources.calendar.access.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_VIEW`	2
`ACCESS_LEVEL_SHARE`	3
`ACCESS_LEVEL_EDIT`	4
`ACCESS_LEVEL_MANAGE`	5

resources/common/content/content.proto

resources.common.content.Content

Field	Type	Label	Description
`version`	string
`content_type`	ContentType
`raw_html`	string	optional	Deprecated: Legacy HTML (only for viewing old content)
`content`	RichTextHtmlNode	optional	Deprecated: Legacy custom HTML to JSON AST (only for viewing old content)
`tiptap_json`	google.protobuf.Struct		Tiptap JSON Document

resources.common.content.ExtractedContent

Field	Type	Label	Description
`text`	string
`word_count`	uint32
`first_heading`	string

resources.common.content.RichTextHtmlNode

Field	Type	Label
`type`	NodeType
`id`	string	optional
`tag`	string
`attrs`	RichTextHtmlNode.AttrsEntry	repeated
`text`	string	optional
`content`	RichTextHtmlNode	repeated

resources.common.content.RichTextHtmlNode.AttrsEntry

Field	Type	Label	Description
`key`	string
`value`	string

resources.common.content.ContentType

Name	Number	Description
`CONTENT_TYPE_UNSPECIFIED`	0
`CONTENT_TYPE_HTML`	1	Used for legacy HTML content
`CONTENT_TYPE_TIPTAP_JSON`	2	Used for Tiptap JSON content

resources.common.content.NodeType

Name	Number	Description
`NODE_TYPE_UNSPECIFIED`	0
`NODE_TYPE_DOC`	1
`NODE_TYPE_ELEMENT`	2
`NODE_TYPE_TEXT`	3
`NODE_TYPE_COMMENT`	4

resources/calendar/calendar.proto

resources.calendar.Calendar

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`job`	string	optional
`system_kind`	CalendarSystemKind	optional
`name`	string
`description`	resources.common.content.Content	optional
`public`	bool
`closed`	bool
`color`	string
`icon`	string	optional
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`subscription`	CalendarSub	optional
`access`	resources.access.Access
`discord_settings`	CalendarDiscordSettings	optional

resources.calendar.CalendarDiscordReminderEmbed

Field	Type	Label
`title`	string	optional
`description`	string	optional
`color`	string	optional

resources.calendar.CalendarDiscordReminderStep

Field	Type	Label
`at_minute`	int32
`message`	string	optional
`embed`	CalendarDiscordReminderEmbed	optional

resources.calendar.CalendarDiscordSettings

Field	Type	Label
`enabled`	bool
`channel_id`	string
`reminder_steps`	CalendarDiscordReminderStep	repeated

resources.calendar.CalendarShort

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`job`	string	optional
`name`	string
`description`	resources.common.content.Content	optional
`public`	bool
`closed`	bool
`color`	string
`subscription`	CalendarSub	optional
`system_kind`	CalendarSystemKind	optional

resources.calendar.CalendarSub

Field	Type	Label
`calendar_id`	int64
`user_id`	int32
`user`	resources.users.short.UserShort	optional
`created_at`	resources.timestamp.Timestamp	optional
`confirmed`	bool
`muted`	bool

resources.calendar.CalendarSystemKind

Name	Number	Description
`CALENDAR_SYSTEM_KIND_UNSPECIFIED`	0
`CALENDAR_SYSTEM_KIND_JOB_BIRTHDAYS`	1

resources/calendar/entries/entries.proto

resources.calendar.entries.CalendarEntry

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`calendar_id`	int64
`calendar`	resources.calendar.Calendar	optional
`job`	string	optional
`start_time`	resources.timestamp.Timestamp
`end_time`	resources.timestamp.Timestamp	optional
`all_day`	bool
`title`	string
`content`	resources.common.content.Content
`closed`	bool
`rsvp_open`	bool	optional
`icon`	string	optional
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`recurring`	CalendarEntryRecurring	optional
`rsvp`	CalendarEntryRSVP	optional
`occurrence`	CalendarEntryOccurrence	optional
`recurring_until`	resources.timestamp.Timestamp	optional
`recurrence_version`	int32

resources.calendar.entries.CalendarEntryOccurrence

Field	Type	Label
`key`	string
`kind`	CalendarEntryOccurrenceKind
`source_entry_id`	int64	optional
`source_user_id`	int32	optional
`all_day`	bool

resources.calendar.entries.CalendarEntryRSVP

Field	Type	Label
`entry_id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`user_id`	int32
`user`	resources.users.short.UserShort	optional
`response`	RsvpResponses
`occurrence_key`	string	optional

resources.calendar.entries.CalendarEntryRecurring

Field	Type	Label
`every`	CalendarEntryRecurringEvery
`count`	int32
`until`	resources.timestamp.Timestamp	optional

resources.calendar.entries.CalendarEntryOccurrenceKind

Name	Number	Description
`CALENDAR_ENTRY_OCCURRENCE_KIND_UNSPECIFIED`	0
`CALENDAR_ENTRY_OCCURRENCE_KIND_MANUAL`	1
`CALENDAR_ENTRY_OCCURRENCE_KIND_RECURRING`	2
`CALENDAR_ENTRY_OCCURRENCE_KIND_BIRTHDAY`	3

resources.calendar.entries.CalendarEntryRecurringEvery

Name	Number	Description
`CALENDAR_ENTRY_RECURRING_EVERY_UNSPECIFIED`	0
`CALENDAR_ENTRY_RECURRING_EVERY_DAY`	1
`CALENDAR_ENTRY_RECURRING_EVERY_WEEK`	2
`CALENDAR_ENTRY_RECURRING_EVERY_MONTH`	3
`CALENDAR_ENTRY_RECURRING_EVERY_YEAR`	4

resources.calendar.entries.RsvpResponses

Name	Number	Description
`RSVP_RESPONSES_UNSPECIFIED`	0
`RSVP_RESPONSES_HIDDEN`	1
`RSVP_RESPONSES_INVITED`	2
`RSVP_RESPONSES_NO`	3
`RSVP_RESPONSES_MAYBE`	4
`RSVP_RESPONSES_YES`	5

resources/centrum/access/access.proto

resources.centrum.access.CentrumAccess

Field	Type	Label	Description
`jobs`	CentrumJobAccess	repeated

resources.centrum.access.CentrumJobAccess

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`target_id`	int64
`source_job`	string
`job`	string
`job_label`	string	optional
`minimum_grade`	int32
`job_grade_label`	string	optional
`access`	CentrumAccessLevel
`accepted_at`	resources.timestamp.Timestamp	optional

resources.centrum.access.CentrumQualificationAccess

Dummy - DO NOT USE!

resources.centrum.access.CentrumUserAccess

Dummy - DO NOT USE!

resources.centrum.access.CentrumAccessLevel

Name	Number	Description
`CENTRUM_ACCESS_LEVEL_UNSPECIFIED`	0
`CENTRUM_ACCESS_LEVEL_BLOCKED`	1
`CENTRUM_ACCESS_LEVEL_VIEW`	2
`CENTRUM_ACCESS_LEVEL_PARTICIPATE`	3
`CENTRUM_ACCESS_LEVEL_DISPATCH`	4

resources/jobs/labels/labels.proto

resources.jobs.labels.Label

Field	Type	Label
`id`	int64
`job`	string	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`name`	string
`color`	string
`icon`	string	optional
`sort_order`	int32

resources.jobs.labels.LabelCount

Field	Type	Label	Description
`label`	Label
`count`	int64

resources.jobs.labels.Labels

Field	Type	Label	Description
`list`	Label	repeated

resources/jobs/colleagues/colleagues.proto

resources.jobs.colleagues.Colleague

Field	Type	Label
`user_id`	int32
`job`	string
`job_label`	string	optional
`job_grade`	int32
`job_grade_label`	string	optional
`firstname`	string
`lastname`	string
`dateofbirth`	string
`phone_number`	string	optional
`profile_picture_file_id`	int64	optional
`profile_picture`	string	optional
`props`	ColleagueProps
`email`	string	optional

resources.jobs.colleagues.ColleagueProps

Field	Type	Label
`user_id`	int32
`job`	string
`deleted_at`	resources.timestamp.Timestamp	optional
`absence_begin`	resources.timestamp.Timestamp	optional
`absence_end`	resources.timestamp.Timestamp	optional
`note`	string	optional
`labels`	resources.jobs.labels.Labels	optional
`name_prefix`	string	optional
`name_suffix`	string	optional

resources/centrum/dispatchers/dispatchers.proto

resources.centrum.dispatchers.Dispatchers

Field	Type	Label
`job`	string
`job_label`	string	optional
`dispatchers`	resources.jobs.colleagues.Colleague	repeated

resources.centrum.dispatchers.JobDispatchers

Field	Type	Label	Description
`dispatchers`	Dispatchers	repeated

resources/centrum/joblist.proto

resources.centrum.JobList

Field	Type	Label	Description
`jobs`	JobListEntry	repeated

resources.centrum.JobListEntry

Field	Type	Label	Description
`name`	string
`label`	string	optional

resources/centrum/units/access/access.proto

resources.centrum.units.access.UnitAccessLevel

Name	Number	Description
`UNIT_ACCESS_LEVEL_UNSPECIFIED`	0
`UNIT_ACCESS_LEVEL_BLOCKED`	1
`UNIT_ACCESS_LEVEL_JOIN`	2

resources/centrum/units/units.proto

resources.centrum.units.Unit

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`job`	string
`job_label`	string	optional
`sort_order`	int32
`name`	string
`initials`	string
`color`	string
`icon`	string	optional
`description`	string	optional
`status`	UnitStatus	optional
`users`	UnitAssignment	repeated
`attributes`	UnitAttributes	optional
`home_postal`	string	optional
`access`	resources.access.Access

resources.centrum.units.UnitAssignment

Field	Type	Label
`unit_id`	int64
`user_id`	int32
`user`	resources.jobs.colleagues.Colleague	optional

resources.centrum.units.UnitAssignments

Field	Type	Label
`unit_id`	int64
`job`	string
`users`	UnitAssignment	repeated

resources.centrum.units.UnitAttributes

Field	Type	Label	Description
`list`	UnitAttribute	repeated

resources.centrum.units.UnitStatus

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`unit_id`	int64
`unit`	Unit	optional
`status`	StatusUnit
`reason`	string	optional
`code`	string	optional
`user_id`	int32	optional
`user`	resources.jobs.colleagues.Colleague	optional
`x`	double	optional
`y`	double	optional
`postal`	string	optional
`creator_id`	int32	optional
`creator`	resources.jobs.colleagues.Colleague	optional
`creator_job`	string	optional

resources.centrum.units.StatusUnit

Name	Number	Description
`STATUS_UNIT_UNSPECIFIED`	0
`STATUS_UNIT_UNKNOWN`	1
`STATUS_UNIT_USER_ADDED`	2
`STATUS_UNIT_USER_REMOVED`	3
`STATUS_UNIT_UNAVAILABLE`	4
`STATUS_UNIT_AVAILABLE`	5
`STATUS_UNIT_ON_BREAK`	6
`STATUS_UNIT_BUSY`	7

resources.centrum.units.UnitAttribute

Name	Number	Description
`UNIT_ATTRIBUTE_UNSPECIFIED`	0
`UNIT_ATTRIBUTE_STATIC`	1
`UNIT_ATTRIBUTE_NO_DISPATCH_AUTO_ASSIGN`	2

resources/centrum/dispatches/dispatches.proto

resources.centrum.dispatches.Dispatch

Field	Type	Label	Description
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`job`	string		Deprecated.
`jobs`	resources.centrum.JobList
`status`	DispatchStatus	optional
`message`	string
`description`	string	optional
`attributes`	DispatchAttributes	optional
`x`	double
`y`	double
`postal`	string	optional
`anon`	bool
`creator_id`	int32	optional
`creator`	resources.users.User	optional
`units`	DispatchAssignment	repeated
`references`	DispatchReferences	optional

resources.centrum.dispatches.DispatchAssignment

Field	Type	Label
`dispatch_id`	int64
`unit_id`	int64
`unit`	resources.centrum.units.Unit	optional
`created_at`	resources.timestamp.Timestamp	optional
`expires_at`	resources.timestamp.Timestamp	optional

resources.centrum.dispatches.DispatchAssignments

Field	Type	Label
`dispatch_id`	int64
`job`	string
`units`	DispatchAssignment	repeated

resources.centrum.dispatches.DispatchAttributes

Field	Type	Label	Description
`list`	DispatchAttribute	repeated

resources.centrum.dispatches.DispatchReference

Field	Type	Label	Description
`target_dispatch_id`	int64
`reference_type`	DispatchReferenceType

resources.centrum.dispatches.DispatchReferences

Field	Type	Label	Description
`references`	DispatchReference	repeated

resources.centrum.dispatches.DispatchStatus

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`dispatch_id`	int64
`unit_id`	int64	optional
`unit`	resources.centrum.units.Unit	optional
`status`	StatusDispatch
`reason`	string	optional
`code`	string	optional
`user_id`	int32	optional
`user`	resources.jobs.colleagues.Colleague	optional
`x`	double	optional
`y`	double	optional
`postal`	string	optional
`creator_job`	string	optional

resources.centrum.dispatches.DispatchAttribute

Name	Number	Description
`DISPATCH_ATTRIBUTE_UNSPECIFIED`	0
`DISPATCH_ATTRIBUTE_MULTIPLE`	1
`DISPATCH_ATTRIBUTE_DUPLICATE`	2
`DISPATCH_ATTRIBUTE_TOO_OLD`	3
`DISPATCH_ATTRIBUTE_AUTOMATIC`	4

resources.centrum.dispatches.DispatchReferenceType

Name	Number	Description
`DISPATCH_REFERENCE_TYPE_UNSPECIFIED`	0
`DISPATCH_REFERENCE_TYPE_REFERENCED`	1
`DISPATCH_REFERENCE_TYPE_DUPLICATED_BY`	2
`DISPATCH_REFERENCE_TYPE_DUPLICATE_OF`	3

resources.centrum.dispatches.StatusDispatch

Name	Number	Description
`STATUS_DISPATCH_UNSPECIFIED`	0
`STATUS_DISPATCH_NEW`	1
`STATUS_DISPATCH_UNASSIGNED`	2
`STATUS_DISPATCH_UPDATED`	3
`STATUS_DISPATCH_UNIT_ASSIGNED`	4
`STATUS_DISPATCH_UNIT_UNASSIGNED`	5
`STATUS_DISPATCH_UNIT_ACCEPTED`	6
`STATUS_DISPATCH_UNIT_DECLINED`	7
`STATUS_DISPATCH_EN_ROUTE`	8
`STATUS_DISPATCH_ON_SCENE`	9
`STATUS_DISPATCH_NEED_ASSISTANCE`	10
`STATUS_DISPATCH_COMPLETED`	11
`STATUS_DISPATCH_CANCELLED`	12
`STATUS_DISPATCH_ARCHIVED`	13
`STATUS_DISPATCH_DELETED`	14

resources.centrum.dispatches.TakeDispatchResp

Name	Number	Description
`TAKE_DISPATCH_RESP_UNSPECIFIED`	0
`TAKE_DISPATCH_RESP_TIMEOUT`	1
`TAKE_DISPATCH_RESP_ACCEPTED`	2
`TAKE_DISPATCH_RESP_DECLINED`	3

resources/centrum/settings/settings.proto

resources.centrum.settings.Configuration

Field	Type	Label
`deduplication_enabled`	bool
`deduplication_radius`	int64
`deduplication_duration`	google.protobuf.Duration	optional

resources.centrum.settings.EffectiveAccess

Field	Type	Label	Description
`dispatches`	EffectiveDispatchAccess

resources.centrum.settings.EffectiveDispatchAccess

Field	Type	Label	Description
`jobs`	JobAccessEntry	repeated

resources.centrum.settings.JobAccessEntry

Field	Type	Label
`job`	string
`job_label`	string	optional
`access`	resources.centrum.access.CentrumAccessLevel

resources.centrum.settings.PredefinedStatus

Field	Type	Label	Description
`unit_status`	string	repeated
`dispatch_status`	string	repeated

resources.centrum.settings.Settings

Field	Type	Label
`job`	string
`enabled`	bool
`type`	CentrumType
`public`	bool
`mode`	CentrumMode
`fallback_mode`	CentrumMode
`predefined_status`	PredefinedStatus	optional
`timings`	Timings
`configuration`	Configuration
`access`	resources.centrum.access.CentrumAccess	optional
`offered_access`	resources.centrum.access.CentrumAccess	optional
`effective_access`	EffectiveAccess	optional

resources.centrum.settings.Timings

Field	Type	Label	Description
`dispatch_max_wait`	int64
`require_unit`	bool
`require_unit_reminder_seconds`	int64

resources.centrum.settings.CentrumMode

Name	Number	Description
`CENTRUM_MODE_UNSPECIFIED`	0
`CENTRUM_MODE_MANUAL`	1
`CENTRUM_MODE_CENTRAL_COMMAND`	2
`CENTRUM_MODE_AUTO_ROUND_ROBIN`	3
`CENTRUM_MODE_SIMPLIFIED`	4

resources.centrum.settings.CentrumType

Name	Number	Description
`CENTRUM_TYPE_UNSPECIFIED`	0
`CENTRUM_TYPE_DISPATCH`	1
`CENTRUM_TYPE_DELIVERY`	2

resources/citizens/labels/access.proto

resources.citizens.labels.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_VIEW`	2
`ACCESS_LEVEL_GIVE`	3
`ACCESS_LEVEL_REMOVE`	4

resources/settings/banner.proto

resources.settings.BannerMessage

Field	Type	Label
`id`	string
`title`	string
`icon`	string	optional
`color`	string	optional
`created_at`	resources.timestamp.Timestamp
`expires_at`	resources.timestamp.Timestamp	optional

resources/settings/data.proto

resources.settings.Data

Field	Type	Label	Description
`mode`	DataMode

resources.settings.DataMode

Name	Number	Description
`DATA_MODE_UNSPECIFIED`	0
`DATA_MODE_UNAVAILABLE`	1
`DATA_MODE_READONLY`	2
`DATA_MODE_READWRITE`	3

resources/settings/config.proto

resources.settings.AppConfig

Field	Type	Label
`version`	string
`setup_complete`	bool	optional
`default_locale`	string
`auth`	Auth
`perms`	Perms
`website`	Website
`job_info`	JobInfo
`user_tracker`	UserTracker
`discord`	Discord
`system`	System
`display`	Display
`quick_buttons`	QuickButtons
`data`	Data
`livemap`	Livemap
`game`	Game

resources.settings.Auth

Field	Type	Label
`signup_enabled`	bool
`last_char_lock`	bool
`job_admin_groups`	string	repeated
`job_admin_users`	string	repeated
`config_admin_groups`	string	repeated
`config_admin_users`	string	repeated

resources.settings.Discord

Field	Type	Label
`enabled`	bool
`sync_interval`	google.protobuf.Duration
`invite_url`	string	optional
`ignored_jobs`	string	repeated
`bot_presence`	DiscordBotPresence	optional
`bot_id`	string	optional
`bot_permissions`	int64

resources.settings.DiscordBotPresence

Field	Type	Label
`type`	DiscordBotPresenceType
`status`	string	optional
`url`	string	optional

resources.settings.Display

Field	Type	Label	Description
`intl_locale`	string		IETF BCP 47 language tag (e.g. "en-US", "de-DE")
`currency_name`	string		ISO 4217 currency code (e.g. "USD", "EUR")

resources.settings.Game

Field	Type	Label
`max_wanted_duration_user_enabled`	bool
`max_wanted_duration_user`	google.protobuf.Duration	optional
`max_wanted_duration_vehicle_enabled`	bool
`max_wanted_duration_vehicle`	google.protobuf.Duration	optional

resources.settings.JobInfo

Field	Type	Label
`unemployed_job`	UnemployedJob
`public_jobs`	string	repeated
`hidden_jobs`	string	repeated

resources.settings.Links

Field	Type	Label	Description
`privacy_policy`	string	optional
`imprint`	string	optional

resources.settings.Livemap

Field	Type	Label	Description
`enable_cayo_perico`	bool

resources.settings.PenaltyCalculator

Field	Type	Label
`max_count`	uint32	optional
`detention_time_unit`	PenaltyCalculatorDetentionTimeUnit	optional
`warn_settings`	PenaltyCalculatorWarn	optional
`max_leeway`	uint32	optional

resources.settings.PenaltyCalculatorDetentionTimeUnit

Field	Type	Label	Description
`singular`	string	optional
`plural`	string	optional

resources.settings.PenaltyCalculatorWarn

Field	Type	Label
`enabled`	bool
`fine`	uint32	optional
`detention_time`	uint32	optional
`stvo_points`	uint32	optional
`warn_message`	string	optional

resources.settings.Perm

Field	Type	Label	Description
`category`	string
`name`	string

resources.settings.Perms

Field	Type	Label	Description
`default`	Perm	repeated

resources.settings.QuickButtons

Field	Type	Label	Description
`penalty_calculator`	PenaltyCalculator

resources.settings.System

Field	Type	Label	Description
`banner_message_enabled`	bool
`banner_message`	BannerMessage

resources.settings.UnemployedJob

Field	Type	Label	Description
`name`	string
`grade`	int32

resources.settings.UserTracker

Field	Type	Label	Description
`refresh_time`	google.protobuf.Duration
`db_refresh_time`	google.protobuf.Duration

resources.settings.Website

Field	Type	Label	Description
`links`	Links
`stats_page`	bool

resources.settings.DiscordBotPresenceType

Name	Number	Description
`DISCORD_BOT_PRESENCE_TYPE_UNSPECIFIED`	0
`DISCORD_BOT_PRESENCE_TYPE_GAME`	1
`DISCORD_BOT_PRESENCE_TYPE_LISTENING`	2
`DISCORD_BOT_PRESENCE_TYPE_STREAMING`	3
`DISCORD_BOT_PRESENCE_TYPE_WATCH`	4

resources/clientconfig/clientconfig.proto

resources.clientconfig.Auth

Field	Type	Label
`signup_enabled`	bool
`last_char_lock`	bool
`providers`	ProviderConfig	repeated

resources.clientconfig.ClientConfig

Field	Type	Label
`version`	string
`setup_complete`	bool	optional
`default_locale`	string
`auth`	Auth
`discord`	Discord
`website`	resources.settings.Website
`feature_gates`	FeatureGates
`game`	Game
`system`	System
`display`	resources.settings.Display
`quick_buttons`	resources.settings.QuickButtons
`data`	resources.settings.Data

resources.clientconfig.Discord

Field	Type	Label	Description
`bot_enabled`	bool

resources.clientconfig.FeatureGates

resources.clientconfig.Game

Field	Type	Label
`unemployed_job_name`	string
`start_job_grade`	int32
`livemap`	resources.settings.Livemap
`max_wanted_duration_user_enabled`	bool
`max_wanted_duration_user`	google.protobuf.Duration	optional
`max_wanted_duration_vehicle_enabled`	bool
`max_wanted_duration_vehicle`	google.protobuf.Duration	optional

resources.clientconfig.OTLPFrontend

Field	Type	Label
`enabled`	bool
`url`	string
`headers`	OTLPFrontend.HeadersEntry	repeated

resources.clientconfig.OTLPFrontend.HeadersEntry

Field	Type	Label	Description
`key`	string
`value`	string

resources.clientconfig.ProviderConfig

Field	Type	Label
`name`	string
`label`	string
`icon`	string	optional
`homepage`	string

resources.clientconfig.System

Field	Type	Label
`banner_message_enabled`	bool
`banner_message`	resources.settings.BannerMessage	optional
`otlp`	OTLPFrontend

resources/collab/collab.proto

resources.collab.AwarenessPing

Field	Type	Label	Description
`data`	bytes

resources.collab.ClientPacket

Field	Type	Description
`hello`	CollabInit	Must be the first message
`sync_step`	SyncStep
`yjs_update`	YjsUpdate
`awareness`	AwarenessPing

resources.collab.ClientUpdate

Field	Type	Label
`joined`	bool
`client_id`	uint64
`label`	string	optional

resources.collab.CollabHandshake

Field	Type	Label	Description
`client_id`	uint64

resources.collab.CollabInit

Field	Type	Label	Description
`target_id`	int64

resources.collab.ServerPacket

Field	Type	Description
`sender_id`	uint64	Who generated this packet (same ID used in awareness)
`handshake`	CollabHandshake
`sync_step`	SyncStep
`yjs_update`	YjsUpdate
`awareness`	AwarenessPing
`target_saved`	TargetSaved
`promote`	FirstPromote
`client_update`	ClientUpdate

resources.collab.SyncStep

Field	Type	Label
`step`	int32
`data`	bytes
`receiver_id`	uint64	optional

resources.collab.TargetSaved

Field	Type	Label	Description
`target_id`	int64

resources.collab.YjsUpdate

Field	Type	Label	Description
`data`	bytes

resources.collab.ClientRole

Name	Number	Description
`CLIENT_ROLE_UNSPECIFIED`	0
`CLIENT_ROLE_READER`	1
`CLIENT_ROLE_WRITER`	2

resources/common/content/diff_activity.proto

resources.common.content.ContentDiff

Field	Type	Label	Description
`stats`	ContentDiffStats		Quick summary for badge like "+12 / -3"
`ops`	ContentDiffOp	repeated	The diff itself for inline rendering

resources.common.content.ContentDiffOp

One diff operation, designed for inline client rendering.

Field	Type	Label	Description
`kind`	Kind
`text`	string		Plain text segment. Can contain whitespace and newlines. Client renders: - EQUAL: normal text - INSERT: highlighted - DELETE: strikethrough or hidden behind a toggle

resources.common.content.ContentDiffStats

Optional stats to quickly show "what changed" without parsing ops.

Field	Type	Description
`inserted_runes`	uint32	Counts are measured in runes/codepoints on the server side.
`deleted_runes`	uint32
`op_count`	uint32	Optional: number of diff ops (after cleanup/coalescing).

resources.common.content.Kind

Name	Number	Description
`KIND_UNSPECIFIED`	0
`KIND_EQUAL`	1
`KIND_INSERT`	2
`KIND_DELETE`	3

resources/common/database/database.proto

resources.common.database.DateRange

DateRange represents a datetime range (uses Timestamp underneath) It depends on the API method if it will use date or date + time.

Field	Type	Label	Description
`start`	resources.timestamp.Timestamp		Start time
`end`	resources.timestamp.Timestamp		End time

resources.common.database.PaginationRequest

Pagination for requests to the server

Field	Type	Label	Description
`offset`	int64
`page_size`	int64	optional

resources.common.database.PaginationResponse

Server Pagination Response

Field	Type	Label	Description
`total_count`	int64
`offset`	int64
`end`	int64
`page_size`	int64

resources.common.database.Sort

Field	Type	Label	Description
`columns`	SortByColumn	repeated

resources.common.database.SortByColumn

SortByColumn sort by column and direction

Field	Type	Label	Description
`id`	string		ID is the column name.
`desc`	bool		Desc if true sorts descending, ascending otherwise.

resources/common/i18n.proto

resources.common.I18NItem

Wrapped translated message for the client

Field	Type	Label	Description
`key`	string
`parameters`	I18NItem.ParametersEntry	repeated

resources.common.I18NItem.ParametersEntry

Field	Type	Label	Description
`key`	string
`value`	string

resources/common/error.proto

resources.common.Error

Field	Type	Label	Description
`title`	I18NItem	optional
`content`	I18NItem

resources/common/id_mapping.proto

resources.common.IDMapping

Field	Type	Label	Description
`id`	int64

resources/common/tests/objects.proto

resources.common.tests.SimpleObject

INTERNAL ONLY** SimpleObject is used as a test object where proto-based messages are required.

Field	Type	Label	Description
`field1`	string
`field2`	bool

resources/cron/cron.proto

resources.cron.Cronjob

Field	Type	Label	Description
`name`	string		Cronjob name
`schedule`	string		Cron schedule expression For available valid expressions, see adhocore/gronx - Cron Expressions Documentation. To generate Cronjob schedule expressions, you can also use web tools like https://crontab.guru/.
`state`	CronjobState		Cronjob state
`next_schedule_time`	resources.timestamp.Timestamp		Next time the cronjob should be run
`last_attempt_time`	resources.timestamp.Timestamp	optional	Last attempted start time of Cronjob
`started_time`	resources.timestamp.Timestamp	optional	Time current cronjob was started
`timeout`	google.protobuf.Duration	optional	Optional timeout for cronjob execution
`data`	CronjobData		Cronjob data
`last_completed_event`	CronjobCompletedEvent	optional	Last event info to ease debugging and tracking

resources.cron.CronjobCompletedEvent

Field	Type	Label	Description
`name`	string		Cronjob name
`success`	bool		Cronjob execution success status
`cancelled`	bool		Cronjob execution was cancelled
`end_date`	resources.timestamp.Timestamp		Cronjob end time
`elapsed`	google.protobuf.Duration		Cronjob execution time/elapsed time
`data`	CronjobData	optional	Cronjob data (can be empty if not touched by the Cronjob handler)
`node_name`	string		Name of the node where the cronjob was executed
`error_message`	string	optional	Error message (if success = false)

resources.cron.CronjobData

Field	Type	Label	Description
`updated_at`	resources.timestamp.Timestamp
`data`	google.protobuf.Any	optional

resources.cron.CronjobLockOwnerState

Field	Type	Label	Description
`hostname`	string		Hostname of the agent the cronjob is running on
`updated_at`	resources.timestamp.Timestamp

resources.cron.CronjobSchedulerEvent

Field	Type	Label	Description
`cronjob`	Cronjob		Full Cronjob spec

resources.cron.GenericCronData

Field	Type	Label	Description
`attributes`	GenericCronData.AttributesEntry	repeated

resources.cron.GenericCronData.AttributesEntry

Field	Type	Label	Description
`key`	string
`value`	string

resources.cron.CronjobState

States of Cronjbo

Name	Number	Description
`CRONJOB_STATE_UNSPECIFIED`	0
`CRONJOB_STATE_WAITING`	1
`CRONJOB_STATE_PENDING`	2
`CRONJOB_STATE_RUNNING`	3

resources/discord/discord.proto

resources.discord.Channel

Field	Type	Label	Description
`id`	string
`guild_id`	string
`name`	string
`type`	uint32
`position`	int64

resources.discord.Guild

Field	Type	Label
`id`	string
`name`	string
`icon`	string
`created_at`	resources.timestamp.Timestamp	optional

resources/documents/access/access.proto

resources.documents.access.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_VIEW`	2
`ACCESS_LEVEL_COMMENT`	3
`ACCESS_LEVEL_STATUS`	4
`ACCESS_LEVEL_ACCESS`	5
`ACCESS_LEVEL_EDIT`	6

resources/documents/activity/activity.proto

resources.documents.activity.DocAccessJobsDiff

Field	Type	Label
`to_create`	resources.access.JobAccess	repeated
`to_update`	resources.access.JobAccess	repeated
`to_delete`	resources.access.JobAccess	repeated

resources.documents.activity.DocAccessRequested

Field	Type	Label	Description
`level`	resources.documents.access.AccessLevel

resources.documents.activity.DocAccessUpdated

Field	Type	Label	Description
`jobs`	DocAccessJobsDiff
`users`	DocAccessUsersDiff

resources.documents.activity.DocAccessUsersDiff

Field	Type	Label
`to_create`	resources.access.UserAccess	repeated
`to_update`	resources.access.UserAccess	repeated
`to_delete`	resources.access.UserAccess	repeated

resources.documents.activity.DocActivity

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`document_id`	int64
`activity_type`	DocActivityType
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`reason`	string	optional
`data`	DocActivityData

resources.documents.activity.DocActivityData

Field	Type	Label	Description
`updated`	DocUpdated
`owner_changed`	DocOwnerChanged
`access_updated`	DocAccessUpdated
`access_requested`	DocAccessRequested
`signing_requested`	DocSigningRequested

resources.documents.activity.DocFilesChange

Field	Type	Label	Description
`added`	int64
`deleted`	int64

resources.documents.activity.DocOwnerChanged

Field	Type	Label	Description
`new_owner_id`	int32
`new_owner`	resources.users.short.UserShort

resources.documents.activity.DocSigningRequested

Field	Type	Label	Description
`deadline`	resources.timestamp.Timestamp	optional
`approvers`	resources.users.short.UserShort	repeated

resources.documents.activity.DocUpdated

Field	Type	Label
`title_diff`	string	optional
`title_cdiff`	resources.common.content.ContentDiff	optional
`content_diff`	string	optional
`content_cdiff`	resources.common.content.ContentDiff	optional
`state_diff`	string	optional
`state_cdiff`	resources.common.content.ContentDiff	optional
`files_change`	DocFilesChange	optional

resources.documents.activity.DocActivityType

Name	Number	Description
`DOC_ACTIVITY_TYPE_UNSPECIFIED`	0
`DOC_ACTIVITY_TYPE_CREATED`	1	Base
`DOC_ACTIVITY_TYPE_STATUS_OPEN`	2
`DOC_ACTIVITY_TYPE_STATUS_CLOSED`	3
`DOC_ACTIVITY_TYPE_UPDATED`	4
`DOC_ACTIVITY_TYPE_RELATIONS_UPDATED`	5
`DOC_ACTIVITY_TYPE_REFERENCES_UPDATED`	6
`DOC_ACTIVITY_TYPE_ACCESS_UPDATED`	7
`DOC_ACTIVITY_TYPE_OWNER_CHANGED`	8
`DOC_ACTIVITY_TYPE_DELETED`	9
`DOC_ACTIVITY_TYPE_DRAFT_TOGGLED`	19
`DOC_ACTIVITY_TYPE_COMMENT_ADDED`	10	Comments
`DOC_ACTIVITY_TYPE_COMMENT_UPDATED`	11
`DOC_ACTIVITY_TYPE_COMMENT_DELETED`	12
`DOC_ACTIVITY_TYPE_COMMENT_RESTORED`	22
`DOC_ACTIVITY_TYPE_REQUESTED_ACCESS`	13	Requests
`DOC_ACTIVITY_TYPE_REQUESTED_CLOSURE`	14
`DOC_ACTIVITY_TYPE_REQUESTED_OPENING`	15
`DOC_ACTIVITY_TYPE_REQUESTED_UPDATE`	16
`DOC_ACTIVITY_TYPE_REQUESTED_OWNER_CHANGE`	17
`DOC_ACTIVITY_TYPE_REQUESTED_DELETION`	18
`DOC_ACTIVITY_TYPE_REQUESTED_APPROVAL`	20
`DOC_ACTIVITY_TYPE_APPROVAL_ASSIGNED`	40	Approval
`DOC_ACTIVITY_TYPE_APPROVAL_APPROVED`	41
`DOC_ACTIVITY_TYPE_APPROVAL_REJECTED`	42
`DOC_ACTIVITY_TYPE_APPROVAL_REVOKED`	43
`DOC_ACTIVITY_TYPE_APPROVAL_REMOVED`	44

resources/documents/category/category.proto

resources.documents.category.Category

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`deleted_at`	resources.timestamp.Timestamp	optional
`name`	string
`description`	string	optional
`job`	string	optional
`color`	string	optional
`icon`	string	optional

resources/documents/data/data.proto

resources.documents.data.DocumentData

Field	Type	Label	Description
`penalty_calculator`	PenaltyCalculatorData	optional

resources.documents.data.PenaltyCalculatorData

Field	Type	Label
`reduction`	int32
`selected`	SelectedPenalty	repeated
`total`	PenaltyCalculatorTotal	optional

resources.documents.data.PenaltyCalculatorTotal

Field	Type	Label
`count`	uint32	optional
`fine`	uint32	optional
`detention_time`	uint32	optional
`stvo_points`	uint32	optional

resources.documents.data.SelectedPenalty

Field	Type	Label	Description
`law_id`	int64
`count`	uint32

resources/documents/pins/pins.proto

resources.documents.pins.DocumentPin

Field	Type	Label
`document_id`	int64
`job`	string	optional
`user_id`	int32	optional
`created_at`	resources.timestamp.Timestamp	optional
`state`	bool
`creator_id`	int32

resources/documents/workflow/workflow.proto

resources.documents.workflow.AutoCloseSettings

Field	Type	Label	Description
`duration`	google.protobuf.Duration
`message`	string

resources.documents.workflow.Reminder

Field	Type	Label	Description
`duration`	google.protobuf.Duration
`message`	string

resources.documents.workflow.ReminderSettings

Field	Type	Label	Description
`reminders`	Reminder	repeated
`max_reminder_count`	int32

resources.documents.workflow.Workflow

Field	Type	Label	Description
`reminder`	bool
`reminder_settings`	ReminderSettings
`auto_close`	bool
`auto_close_settings`	AutoCloseSettings

resources.documents.workflow.WorkflowCronData

Field	Type	Label	Description
`last_doc_id`	int64
`processed_rows`	int64
`reminders_sent`	int64
`auto_closed_rows`	int64
`deleted_rows`	int64
`updated_rows`	int64

resources.documents.workflow.WorkflowState

Field	Type	Label
`document_id`	int64
`next_reminder_time`	resources.timestamp.Timestamp	optional
`next_reminder_count`	int32	optional
`reminder_count`	int32
`auto_close_time`	resources.timestamp.Timestamp	optional
`workflow`	Workflow	optional

resources.documents.workflow.WorkflowUserState

Field	Type	Label
`document_id`	int64
`user_id`	int32
`manual_reminder_time`	resources.timestamp.Timestamp	optional
`manual_reminder_message`	string	optional
`reminder_count`	int32
`max_reminder_count`	int32
`workflow`	Workflow	optional

resources/documents/documents.proto

resources.documents.Document

Field	Type	Label	Description
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`category_id`	int64	optional
`category`	category.Category	optional
`title`	string
`word_count`	uint32	optional	Derived field (server authored)
`first_heading`	string	optional	Derived field (server authored)
`content_type`	resources.common.content.ContentType
`content`	resources.common.content.Content
`data`	data.DocumentData	optional
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`meta`	DocumentMeta
`template_id`	int64	optional
`pin`	pins.DocumentPin	optional
`workflow_state`	workflow.WorkflowState	optional
`workflow_user`	workflow.WorkflowUserState	optional
`files`	resources.file.File	repeated

resources.documents.DocumentMeta

Field	Type	Label	Description
`document_id`	int64
`recomputed_at`	resources.timestamp.Timestamp	optional
`closed`	bool
`draft`	bool
`public`	bool
`state`	string
`approved`	bool	optional	Overall aggregates - At least one approval policy fully satisfied
`ap_required_total`	int32	optional	Approval rollups Total approvals needed across policies
`ap_collected_approved`	int32	optional	Approvals collected
`ap_required_remaining`	int32	optional	How many left to satisfy
`ap_declined_count`	int32	optional	Number of declines
`ap_pending_count`	int32	optional	Tasks still pending (optional)
`ap_any_declined`	bool	optional	Quick flag if any declines
`ap_policies_active`	int32	optional	Number of active approval policies
`comment_count`	int32	optional	Number of comments on the document

resources.documents.DocumentShort

Field	Type	Label	Description
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`category_id`	int64	optional
`category`	category.Category	optional
`title`	string
`word_count`	uint32	optional	Derived field (server authored)
`first_heading`	string	optional	Derived field (server authored)
`content_type`	resources.common.content.ContentType
`content`	resources.common.content.Content
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`meta`	DocumentMeta
`pin`	pins.DocumentPin	optional
`workflow_state`	workflow.WorkflowState	optional
`workflow_user`	workflow.WorkflowUserState	optional

resources/documents/stamps/stamp.proto

resources.documents.stamps.Stamp

Field	Type	Label	Description
`id`	int64
`job`	string
`job_label`	string	optional
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`name`	string
`svg_template`	string		Parameterized SVG with slots
`access`	resources.access.Access

resources/documents/approval/approval.proto

resources.documents.approval.Approval

Field	Type	Label	Description
`id`	int64
`document_id`	int64
`snapshot_date`	resources.timestamp.Timestamp
`task_id`	int64	optional	Link to originating task (if any)
`user_id`	int32	optional
`user`	resources.users.short.UserShort	optional
`user_job`	string	optional
`user_job_label`	string	optional
`user_grade`	int32	optional
`user_grade_label`	string	optional
`payload_svg`	string	optional	SVG path, typed preview, stamp fill, etc.
`stamp_id`	int64	optional
`stamp`	resources.documents.stamps.Stamp	optional
`status`	ApprovalStatus
`comment`	string	optional
`created_at`	resources.timestamp.Timestamp
`revoked_at`	resources.timestamp.Timestamp	optional

resources.documents.approval.ApprovalPolicy

Field	Type	Label
`document_id`	int64
`snapshot_date`	resources.timestamp.Timestamp
`on_edit_behavior`	OnEditBehavior
`rule_kind`	ApprovalRuleKind
`required_count`	int32	optional
`signature_required`	bool
`self_approve_allowed`	bool
`assigned_count`	int32
`approved_count`	int32
`declined_count`	int32
`pending_count`	int32
`any_declined`	bool
`started_at`	resources.timestamp.Timestamp	optional
`completed_at`	resources.timestamp.Timestamp	optional
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional

resources.documents.approval.ApprovalTask

Field	Type	Label	Description
`id`	int64
`document_id`	int64
`snapshot_date`	resources.timestamp.Timestamp
`assignee_kind`	ApprovalAssigneeKind
`user_id`	int32	optional
`user`	resources.users.short.UserShort	optional
`job`	string	optional
`job_label`	string	optional
`minimum_grade`	int32	optional
`job_grade_label`	string	optional
`label`	string	optional	"Leadership", "Counterparty Rep"
`signature_required`	bool
`slot_no`	int32		>=1; meaningful only for Job tasks; always 1 for User
`status`	ApprovalTaskStatus
`comment`	string	optional	Optional comment on approve/decline
`created_at`	resources.timestamp.Timestamp
`completed_at`	resources.timestamp.Timestamp	optional
`due_at`	resources.timestamp.Timestamp	optional
`decision_count`	int32
`approval_id`	int64	optional
`creator_id`	int32
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`document`	resources.documents.DocumentShort	optional

resources.documents.approval.ApprovalAssigneeKind

Name	Number	Description
`APPROVAL_ASSIGNEE_KIND_UNSPECIFIED`	0
`APPROVAL_ASSIGNEE_KIND_USER`	1
`APPROVAL_ASSIGNEE_KIND_JOB_GRADE`	2

resources.documents.approval.ApprovalRuleKind

Name	Number	Description
`APPROVAL_RULE_KIND_UNSPECIFIED`	0
`APPROVAL_RULE_KIND_REQUIRE_ALL`	1	Require all approvals (based on tasks created)
`APPROVAL_RULE_KIND_QUORUM_ANY`	2	Quorum of N approvals based on `required_count`

resources.documents.approval.ApprovalStatus

Name	Number	Description
`APPROVAL_STATUS_UNSPECIFIED`	0
`APPROVAL_STATUS_APPROVED`	1
`APPROVAL_STATUS_DECLINED`	2
`APPROVAL_STATUS_REVOKED`	3

resources.documents.approval.ApprovalTaskStatus

Name	Number	Description
`APPROVAL_TASK_STATUS_UNSPECIFIED`	0
`APPROVAL_TASK_STATUS_PENDING`	1
`APPROVAL_TASK_STATUS_APPROVED`	2
`APPROVAL_TASK_STATUS_DECLINED`	3
`APPROVAL_TASK_STATUS_EXPIRED`	4
`APPROVAL_TASK_STATUS_CANCELLED`	5
`APPROVAL_TASK_STATUS_COMPLETED`	6

resources.documents.approval.OnEditBehavior

Policy snapshot applied to a specific version

Name	Number	Description
`ON_EDIT_BEHAVIOR_UNSPECIFIED`	0
`ON_EDIT_BEHAVIOR_KEEP_PROGRESS`	1	Keep approvals where possible
`ON_EDIT_BEHAVIOR_RESET`	2	Reset review on content edits

resources/documents/comment/comment.proto

resources.documents.comment.Comment

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`document_id`	int64
`content`	resources.common.content.Content
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string

resources/documents/forms/forms.proto

resources.documents.forms.Form

Field	Type	Label	Description
`id`	int64

resources/documents/references/references.proto

resources.documents.references.DocumentReference

Field	Type	Label
`id`	int64	optional
`created_at`	resources.timestamp.Timestamp	optional
`source_document_id`	int64
`source_document`	resources.documents.DocumentShort	optional
`reference`	DocReference
`target_document_id`	int64
`target_document`	resources.documents.DocumentShort	optional
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional

resources.documents.references.DocReference

Name	Number	Description
`DOC_REFERENCE_UNSPECIFIED`	0
`DOC_REFERENCE_LINKED`	1
`DOC_REFERENCE_SOLVES`	2
`DOC_REFERENCE_CLOSES`	3
`DOC_REFERENCE_DEPRECATES`	4

resources/documents/relations/relations.proto

resources.documents.relations.DocumentRelation

Field	Type	Label
`id`	int64	optional
`created_at`	resources.timestamp.Timestamp	optional
`document_id`	int64
`document`	resources.documents.DocumentShort	optional
`source_user_id`	int32
`source_user`	resources.users.short.UserShort	optional
`relation`	DocRelation
`target_user_id`	int32
`target_user`	resources.users.short.UserShort	optional

resources.documents.relations.DocRelation

Name	Number	Description
`DOC_RELATION_UNSPECIFIED`	0
`DOC_RELATION_MENTIONED`	1
`DOC_RELATION_TARGETS`	2
`DOC_RELATION_CAUSED`	3

resources/documents/requests/requests.proto

resources.documents.requests.DocRequest

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp
`document_id`	int64
`request_type`	resources.documents.activity.DocActivityType
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`reason`	string	optional
`data`	resources.documents.activity.DocActivityData
`accepted`	bool	optional

resources/documents/stamps/access.proto

resources.documents.stamps.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_USE`	2
`ACCESS_LEVEL_MANAGE`	3

resources/vehicles/props/props.proto

resources.vehicles.props.VehicleProps

Field	Type	Label
`plate`	string
`updated_at`	resources.timestamp.Timestamp	optional
`wanted`	bool	optional
`wanted_reason`	string	optional
`wanted_at`	resources.timestamp.Timestamp	optional
`wanted_till`	resources.timestamp.Timestamp	optional

resources/vehicles/vehicles.proto

resources.vehicles.Vehicle

Field	Type	Label
`plate`	string
`updated_at`	resources.timestamp.Timestamp	optional
`model`	string	optional
`type`	string
`owner_id`	int32	optional
`owner_identifier`	string	optional
`owner`	resources.users.short.UserShort	optional
`job`	string	optional
`job_label`	string	optional
`props`	props.VehicleProps	optional

resources/documents/templates/templates.proto

resources.documents.templates.ObjectSpecs

Field	Type	Label
`required`	bool	optional
`min`	int32	optional
`max`	int32	optional

resources.documents.templates.Template

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`category`	resources.documents.category.Category
`title`	string
`description`	string
`color`	string	optional
`icon`	string	optional
`content_title`	string
`content`	string
`state`	string
`schema`	TemplateSchema
`creator_job`	string
`creator_job_label`	string	optional
`job_access`	resources.access.JobAccess	repeated
`content_access`	resources.access.Access
`workflow`	resources.documents.workflow.Workflow	optional
`approval`	TemplateApproval	optional

resources.documents.templates.TemplateApproval

Field	Type	Label
`enabled`	bool
`policy`	TemplateApprovalPolicy	optional
`tasks`	TemplateApprovalTaskSeed	repeated

resources.documents.templates.TemplateApprovalPolicy

Field	Type	Label
`rule_kind`	resources.documents.approval.ApprovalRuleKind
`on_edit_behavior`	resources.documents.approval.OnEditBehavior
`required_count`	int32	optional
`signature_required`	bool
`self_approve_allowed`	bool

resources.documents.templates.TemplateApprovalTaskSeed

Field	Type	Label	Description
`user_id`	int32
`job`	string		If user_id == 0 -> JOB task
`minimum_grade`	int32
`label`	string	optional	Label of task
`signature_required`	bool
`slots`	int32		Only for JOB tasks; number of PENDING slots to ensure (>=1)
`due_in_days`	int32	optional	Optional default due date for created slots
`comment`	string	optional	Optional note set on created tasks

resources.documents.templates.TemplateData

Field	Type	Label
`active_char`	resources.users.User
`documents`	resources.documents.DocumentShort	repeated
`users`	resources.users.short.UserShort	repeated
`vehicles`	resources.vehicles.Vehicle	repeated

resources.documents.templates.TemplateRequirements

Field	Type	Label
`documents`	ObjectSpecs	optional
`users`	ObjectSpecs	optional
`vehicles`	ObjectSpecs	optional

resources.documents.templates.TemplateSchema

Field	Type	Label	Description
`requirements`	TemplateRequirements

resources.documents.templates.TemplateShort

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`category`	resources.documents.category.Category
`title`	string
`description`	string
`color`	string	optional
`icon`	string	optional
`schema`	TemplateSchema
`creator_job`	string
`creator_job_label`	string	optional
`workflow`	resources.documents.workflow.Workflow	optional

resources/file/filestore.proto

resources.file.DeleteFileRequest

Field	Type	Label	Description
`parent_id`	int64
`file_id`	int64

resources.file.DeleteFileResponse

resources.file.UploadFileRequest

Field	Type	Label	Description
`meta`	UploadMeta
`data`	bytes		Raw bytes <= 128 KiB each, browsers should only read 64 KiB at a time, but this is a buffer just in case

resources.file.UploadFileResponse

Field	Type	Description
`id`	int64	Unique ID for the uploaded file
`url`	string	URL to the uploaded file
`file`	File	File info

resources.file.UploadMeta

Field	Type	Description
`parent_id`	int64
`namespace`	string	"documents", "wiki", …
`original_name`	string
`content_type`	string	optional - server re-validates
`size`	int64	Size in bytes
`reason`	string

resources/grpcws/grpcws.proto

resources.grpcws.Body

Field	Type	Label	Description
`data`	bytes
`complete`	bool

resources.grpcws.Failure

Field	Type	Label
`error_message`	string
`error_status`	string
`headers`	Failure.HeadersEntry	repeated

resources.grpcws.Failure.HeadersEntry

Field	Type	Label	Description
`key`	string
`value`	HeaderValue

resources.grpcws.GrpcFrame

Field	Type	Label	Description
`stream_id`	uint32
`ping`	Ping
`header`	Header
`body`	Body
`complete`	Complete
`failure`	Failure
`cancel`	Cancel

resources.grpcws.Header

Field	Type	Label
`operation`	string
`headers`	Header.HeadersEntry	repeated
`status`	int32

resources.grpcws.Header.HeadersEntry

Field	Type	Label	Description
`key`	string
`value`	HeaderValue

resources.grpcws.HeaderValue

Field	Type	Label	Description
`value`	string	repeated

resources.grpcws.Ping

Field	Type	Label	Description
`pong`	bool

resources/jobs/colleagues/activity/activity.proto

resources.jobs.colleagues.activity.AbsenceDateChange

Field	Type	Label	Description
`absence_begin`	resources.timestamp.Timestamp
`absence_end`	resources.timestamp.Timestamp

resources.jobs.colleagues.activity.ColleagueActivity

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`job`	string
`source_user_id`	int32	optional
`source_user`	resources.jobs.colleagues.Colleague	optional
`target_user_id`	int32
`target_user`	resources.jobs.colleagues.Colleague
`activity_type`	ColleagueActivityType
`reason`	string
`data`	ColleagueActivityData

resources.jobs.colleagues.activity.ColleagueActivityData

Field	Type	Label	Description
`absence_date`	AbsenceDateChange
`grade_change`	GradeChange
`labels_change`	LabelsChange
`name_change`	NameChange

resources.jobs.colleagues.activity.GradeChange

Field	Type	Label	Description
`grade`	int32
`grade_label`	string

resources.jobs.colleagues.activity.LabelsChange

Field	Type	Label	Description
`added`	resources.jobs.labels.Label	repeated
`removed`	resources.jobs.labels.Label	repeated	TODO switch to storing label ids instead of the whole label (resolve labels on client-side)

resources.jobs.colleagues.activity.NameChange

Field	Type	Label	Description
`prefix`	string	optional
`suffix`	string	optional

resources.jobs.colleagues.activity.ColleagueActivityType

Name	Number	Description
`COLLEAGUE_ACTIVITY_TYPE_UNSPECIFIED`	0
`COLLEAGUE_ACTIVITY_TYPE_HIRED`	1
`COLLEAGUE_ACTIVITY_TYPE_FIRED`	2
`COLLEAGUE_ACTIVITY_TYPE_PROMOTED`	3
`COLLEAGUE_ACTIVITY_TYPE_DEMOTED`	4
`COLLEAGUE_ACTIVITY_TYPE_ABSENCE_DATE`	5
`COLLEAGUE_ACTIVITY_TYPE_NOTE`	6
`COLLEAGUE_ACTIVITY_TYPE_LABELS`	7
`COLLEAGUE_ACTIVITY_TYPE_NAME`	8

resources/jobs/conduct/conduct.proto

resources.jobs.conduct.ConductEntry

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`job`	string
`type`	ConductType
`draft`	bool
`message`	resources.common.content.Content
`files`	resources.file.File	repeated
`expires_at`	resources.timestamp.Timestamp	optional
`target_user_id`	int32
`target_user`	resources.jobs.colleagues.Colleague	optional
`creator_id`	int32
`creator`	resources.jobs.colleagues.Colleague	optional

resources.jobs.conduct.ConductType

Name	Number	Description
`CONDUCT_TYPE_UNSPECIFIED`	0
`CONDUCT_TYPE_NEUTRAL`	1
`CONDUCT_TYPE_POSITIVE`	2
`CONDUCT_TYPE_NEGATIVE`	3
`CONDUCT_TYPE_WARNING`	4
`CONDUCT_TYPE_SUSPENSION`	5
`CONDUCT_TYPE_NOTE`	6

resources/jobs/groups/access/access.proto

resources.jobs.groups.access.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_VIEW`	2
`ACCESS_LEVEL_EDIT`	4
`ACCESS_LEVEL_MANAGE`	5

resources/jobs/groups/group.proto

resources.jobs.groups.Group

Field	Type	Label	Description
`id`	int64
`job`	string		Job this group belongs to. Groups are job-local.
`name`	string		Main display name, e.g. "Traffic Unit" or "Command Staff".
`description`	string	optional	Optional longer explanation of the group's purpose.
`short_name`	string	optional	Optional compact display name, e.g. "TRF" or "CMD".
`logo_file_id`	int64	optional	Optional file/avatar/logo ID reference.
`logo_file`	resources.file.File	optional	Optional file/avatar/logo reference.
`color`	string	optional	Optional UI color, e.g. hex color or predefined token depending on frontend convention.
`type`	GroupType		Describes the broad membership behavior. This can also be derived from rules/manual members, but storing it can simplify UI.
`state`	GroupState		Current lifecycle state.
`membership_mode`	GroupMembershipMode		Controls whether manually added members must satisfy smart membership rules.
`sort_rank`	string		Lexicographic rank for manual group ordering.
`members_count`	int32		Cached/resolved count of current non-excluded members.
`leaders_count`	int32		Cached count of assigned group leaders.
`rules_count`	int32		Cached count of enabled/defined membership rules.
`exclusions_count`	int32		Cached count of manual exclusions.
`created_by_user_id`	int32	optional	User who created the group.
`created_by`	resources.jobs.colleagues.Colleague	optional
`updated_by_user_id`	int32	optional	User who last updated the group metadata.
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional	Set when the group is "archived"/deleted.

resources.jobs.groups.GroupGradeRule

Field	Type	Label	Description
`type`	GroupGradeRuleType		Determines which grade fields are used.
`grade`	int32	optional	Used by MINIMUM and EXACT.
`min_grade`	int32	optional	Used by RANGE.
`max_grade`	int32	optional	Used by RANGE.
`grade_label`	string	optional	Label for grade, used by MINIMUM and EXACT.
`min_grade_label`	string	optional	Label for min_grade, used by RANGE.
`max_grade_label`	string	optional	Label for max_grade, used by RANGE.

resources.jobs.groups.GroupLeader

Field	Type	Label	Description
`group_id`	int64		Group this leader relation belongs to.
`user_id`	int32		User who can manage/supervise the group. A leader does not automatically have to be a member.
`colleague`	resources.jobs.colleagues.Colleague	optional
`created_by_user_id`	int32	optional	User who assigned this leader.
`created_by`	resources.jobs.colleagues.Colleague	optional
`created_at`	resources.timestamp.Timestamp

resources.jobs.groups.GroupManualMember

Field	Type	Label	Description
`group_id`	int64		Group this manual member relation belongs to.
`user_id`	int32		User explicitly added to the group.
`colleague`	resources.jobs.colleagues.Colleague	optional
`reason`	string	optional	Optional admin/leader-provided reason for the manual assignment.
`created_by_user_id`	int32	optional	User who added this manual member.
`created_by`	resources.jobs.colleagues.Colleague	optional
`created_at`	resources.timestamp.Timestamp

resources.jobs.groups.GroupMemberExclusion

Field	Type	Label	Description
`group_id`	int64		Group this exclusion belongs to.
`user_id`	int32		User excluded from resolved group membership.
`colleague`	resources.jobs.colleagues.Colleague	optional
`reason_type`	GroupExclusionReason		Structured exclusion reason.
`reason`	string	optional	Optional human-readable reason.
`created_by_user_id`	int32	optional	User who created the exclusion.
`created_by`	resources.jobs.colleagues.Colleague	optional
`created_at`	resources.timestamp.Timestamp

resources.jobs.groups.GroupMembershipReason

Field	Type	Label	Description
`source`	GroupMemberSource		Source category that explains why the user appears in the resolved view.
`rule_id`	int64	optional	Rule that caused the membership, if source is RULE.
`type`	GroupMembershipReasonType		Structured reason for UI display/translation.
`detail`	string	optional	Optional free-form detail such as a manually entered reason.

resources.jobs.groups.GroupQualificationRule

Field	Type	Label	Description
`type`	GroupQualificationRuleType		Determines whether all or any listed qualifications are required.
`qualification_ids`	int64	repeated	Qualification IDs checked by this rule.
`require_completed`	bool		If true, only completed/successful qualifications count.

resources.jobs.groups.GroupResolvedMember

Field	Type	Label	Description
`group_id`	int64		Group this resolved membership belongs to.
`user_id`	int32		User being described.
`colleague`	resources.jobs.colleagues.Colleague	optional
`is_member`	bool		True if the user is part of the final operational member set.
`is_leader`	bool		True if the user is a group leader.
`is_excluded`	bool		True if the user was excluded from final membership.
`sources`	GroupMemberSource	repeated	High-level membership sources that apply to this user.
`reasons`	GroupMembershipReason	repeated	Detailed explanations for the UI/admin view.

resources.jobs.groups.GroupRule

Field	Type	Label	Description
`id`	int64
`group_id`	int64		Group this rule belongs to.
`enabled`	bool		Disabled rules remain stored but do not affect resolved membership.
`type`	GroupRuleType		Stored rule body discriminator. This duplicates the oneof for DB/query mapping.
`grade`	GroupGradeRule		Grade/rank-based membership rule.
`qualification`	GroupQualificationRule		Qualification-based membership rule.
`created_by_user_id`	int32	optional	User who created the rule.
`created_by`	resources.jobs.colleagues.Colleague	optional
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional

resources.jobs.groups.GroupExclusionReason

Name	Number	Description
`GROUP_EXCLUSION_REASON_UNSPECIFIED`	0
`GROUP_EXCLUSION_REASON_MANUAL`	1	Generic manual exclusion.
`GROUP_EXCLUSION_REASON_TEMPORARY`	2	Temporary exclusion, e.g. paused assignment or temporary reassignment.
`GROUP_EXCLUSION_REASON_NOT_ELIGIBLE`	3	User technically matches a rule but should not be considered eligible.
`GROUP_EXCLUSION_REASON_OTHER`	4	Any other reason described in the free-text reason field.

resources.jobs.groups.GroupGradeRuleType

Name	Number	Description
`GROUP_GRADE_RULE_TYPE_UNSPECIFIED`	0
`GROUP_GRADE_RULE_TYPE_MINIMUM`	1	Match users with grade >= grade.
`GROUP_GRADE_RULE_TYPE_EXACT`	2	Match users with grade == grade.
`GROUP_GRADE_RULE_TYPE_RANGE`	3	Match users with min_grade <= grade <= max_grade.

resources.jobs.groups.GroupMemberSource

Name	Number	Description
`GROUP_MEMBER_SOURCE_UNSPECIFIED`	0
`GROUP_MEMBER_SOURCE_MANUAL`	1	User was explicitly added to the group.
`GROUP_MEMBER_SOURCE_RULE`	2	User matched one or more group rules.
`GROUP_MEMBER_SOURCE_LEADER`	3	User is a group leader. Usually informational; leader status does not necessarily mean membership.

resources.jobs.groups.GroupMembershipMode

Name	Number	Description
`GROUP_MEMBERSHIP_MODE_UNSPECIFIED`	0
`GROUP_MEMBERSHIP_MODE_FLEXIBLE`	1	Manual members may be added even if they do not match the group's rules.
`GROUP_MEMBERSHIP_MODE_STRICT`	2	Manual members must satisfy the group's rules.

resources.jobs.groups.GroupMembershipReasonType

Name	Number	Description
`GROUP_MEMBERSHIP_REASON_TYPE_UNSPECIFIED`	0
`GROUP_MEMBERSHIP_REASON_TYPE_MANUAL`	1
`GROUP_MEMBERSHIP_REASON_TYPE_RULE`	2
`GROUP_MEMBERSHIP_REASON_TYPE_EXCLUSION`	3
`GROUP_MEMBERSHIP_REASON_TYPE_LEADER`	4

resources.jobs.groups.GroupQualificationRuleType

Name	Number	Description
`GROUP_QUALIFICATION_RULE_TYPE_UNSPECIFIED`	0
`GROUP_QUALIFICATION_RULE_TYPE_ALL`	1	User must have all listed qualifications.
`GROUP_QUALIFICATION_RULE_TYPE_ANY`	2	User must have at least one listed qualification.

resources.jobs.groups.GroupRuleType

Name	Number	Description
`GROUP_RULE_TYPE_UNSPECIFIED`	0
`GROUP_RULE_TYPE_GRADE`	1	Rule has a grade/rank-based rule body.
`GROUP_RULE_TYPE_QUALIFICATION`	2	Rule has a qualification-based rule body.

resources.jobs.groups.GroupState

Name	Number	Description
`GROUP_STATE_UNSPECIFIED`	0
`GROUP_STATE_ACTIVE`	1	Group is active and appears in normal group filters/lists.
`GROUP_STATE_INACTIVE`	2	Group still exists but is hidden from default operational views.
`GROUP_STATE_ARCHIVED`	3	Group is no longer used for current operations, but remains available for history/activity logs.

resources.jobs.groups.GroupType

Name	Number	Description
`GROUP_TYPE_UNSPECIFIED`	0
`GROUP_TYPE_MANUAL`	1	Membership is only based on explicitly added manual members.
`GROUP_TYPE_SMART`	2	Membership is derived from rules, such as grade/rank or qualifications.
`GROUP_TYPE_MIXED`	3	Membership is derived from rules and adjusted by manual includes/exclusions.

resources/jobs/groups/activity.proto

resources.jobs.groups.GroupActivity

Field	Type	Label	Description
`id`	int64
`job`	string
`group_id`	int64
`type`	GroupActivityType
`actor_user_id`	int32	optional
`actor_user`	resources.jobs.colleagues.Colleague	optional
`target_user_id`	int32	optional	Optional target user for member/leader events.
`target_user`	resources.jobs.colleagues.Colleague	optional
`rule_id`	int64	optional	Optional target rule for rule events.
`reason`	string	optional
`created_at`	resources.timestamp.Timestamp
`data`	GroupActivityData

resources.jobs.groups.GroupActivityData

Field	Type	Label	Description
`rule`	GroupRule

resources.jobs.groups.GroupActivityType

Name	Number	Description
`GROUP_ACTIVITY_TYPE_UNSPECIFIED`	0
`GROUP_ACTIVITY_TYPE_CREATED`	1
`GROUP_ACTIVITY_TYPE_UPDATED`	2
`GROUP_ACTIVITY_TYPE_ARCHIVED`	3
`GROUP_ACTIVITY_TYPE_RESTORED`	4
`GROUP_ACTIVITY_TYPE_MEMBER_ADDED`	10
`GROUP_ACTIVITY_TYPE_MEMBER_REMOVED`	11
`GROUP_ACTIVITY_TYPE_MEMBER_EXCLUDED`	12
`GROUP_ACTIVITY_TYPE_MEMBER_EXCLUSION_REMOVED`	13
`GROUP_ACTIVITY_TYPE_LEADER_ADDED`	20
`GROUP_ACTIVITY_TYPE_LEADER_REMOVED`	21
`GROUP_ACTIVITY_TYPE_RULE_ADDED`	30
`GROUP_ACTIVITY_TYPE_RULE_UPDATED`	31
`GROUP_ACTIVITY_TYPE_RULE_REMOVED`	32
`GROUP_ACTIVITY_TYPE_LOGO_UPDATED`	40

resources/jobs/settings/settings.proto

resources.jobs.settings.DiscordSyncChange

Field	Type	Label	Description
`time`	resources.timestamp.Timestamp
`plan`	string

resources.jobs.settings.DiscordSyncChanges

Field	Type	Label	Description
`changes`	DiscordSyncChange	repeated

resources.jobs.settings.DiscordSyncSettings

Field	Type	Label	Description
`dry_run`	bool
`user_info_sync`	bool
`user_info_sync_settings`	UserInfoSyncSettings
`status_log`	bool
`status_log_settings`	StatusLogSettings
`jobs_absence`	bool
`jobs_absence_settings`	JobsAbsenceSettings
`group_sync_settings`	GroupSyncSettings
`qualifications_role_format`	string

resources.jobs.settings.GroupMapping

Field	Type	Label	Description
`name`	string
`from_grade`	int32
`to_grade`	int32

resources.jobs.settings.GroupSyncSettings

Field	Type	Label	Description
`ignored_role_ids`	string	repeated

resources.jobs.settings.JobSettings

Field	Type	Label	Description
`absence_past_days`	int32
`absence_future_days`	int32

resources.jobs.settings.JobsAbsenceSettings

Field	Type	Label	Description
`absence_role`	string

resources.jobs.settings.StatusLogSettings

Field	Type	Label	Description
`channel_id`	string

resources.jobs.settings.UserInfoSyncSettings

Field	Type	Label
`employee_role_enabled`	bool
`employee_role_format`	string
`grade_role_format`	string
`unemployed_enabled`	bool
`unemployed_mode`	UserInfoSyncUnemployedMode
`unemployed_role_name`	string
`sync_nicknames`	bool
`group_mapping`	GroupMapping	repeated

resources.jobs.settings.UserInfoSyncUnemployedMode

Name	Number	Description
`USER_INFO_SYNC_UNEMPLOYED_MODE_UNSPECIFIED`	0
`USER_INFO_SYNC_UNEMPLOYED_MODE_GIVE_ROLE`	1
`USER_INFO_SYNC_UNEMPLOYED_MODE_KICK`	2

resources/jobs/props/props.proto

resources.jobs.props.JobProps

Field	Type	Label
`job`	string
`job_label`	string	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`livemap_marker_color`	string
`quick_buttons`	QuickButtons
`radio_frequency`	string	optional
`discord_guild_id`	string	optional
`discord_last_sync`	resources.timestamp.Timestamp	optional
`discord_sync_settings`	resources.jobs.settings.DiscordSyncSettings
`discord_sync_changes`	resources.jobs.settings.DiscordSyncChanges	optional
`motd`	string	optional
`logo_file_id`	int64	optional
`logo_file`	resources.file.File	optional
`settings`	resources.jobs.settings.JobSettings

resources.jobs.props.QuickButtons

Field	Type	Label	Description
`penalty_calculator`	bool

resources/jobs/timeclock/timeclock.proto

resources.jobs.timeclock.TimeclockEntry

Field	Type	Label
`user_id`	int32
`job`	string
`date`	resources.timestamp.Timestamp
`user`	resources.jobs.colleagues.Colleague	optional
`start_time`	resources.timestamp.Timestamp	optional
`end_time`	resources.timestamp.Timestamp	optional
`spent_time`	float

resources.jobs.timeclock.TimeclockStats

Field	Type	Label	Description
`job`	string
`spent_time_sum`	float
`spent_time_avg`	float
`spent_time_max`	float

resources.jobs.timeclock.TimeclockWeeklyStats

Field	Type	Label	Description
`year`	int32
`calendar_week`	int32
`sum`	float
`avg`	float
`max`	float

resources.jobs.timeclock.TimeclockMode

Name	Number	Description
`TIMECLOCK_MODE_UNSPECIFIED`	0
`TIMECLOCK_MODE_DAILY`	1
`TIMECLOCK_MODE_WEEKLY`	2
`TIMECLOCK_MODE_RANGE`	3
`TIMECLOCK_MODE_TIMELINE`	4

resources.jobs.timeclock.TimeclockViewMode

Name	Number	Description
`TIMECLOCK_VIEW_MODE_UNSPECIFIED`	0
`TIMECLOCK_VIEW_MODE_SELF`	1
`TIMECLOCK_VIEW_MODE_ALL`	2

resources/jobs/user_selector.proto

resources.jobs.GroupUserSelector

Field	Type	Label	Description
`group_ids`	int64	repeated
`include_leaders`	bool		Include group leaders even if they are not resolved members.
`include_excluded`	bool		Normally false: group exclusions should be respected.

resources.jobs.UserSelector

Field	Type	Label	Description
`user_ids`	int32	repeated	Explicit users to include.
`groups`	GroupUserSelector		Users resolved from job groups.

resources/laws/laws.proto

resources.laws.Law

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`lawbook_id`	int64
`sort_order`	int32
`name`	string
`description`	string	optional
`hint`	string	optional
`fine`	uint32	optional
`detention_time`	uint32	optional
`stvo_points`	uint32	optional

resources.laws.LawBook

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`sort_order`	int32
`name`	string
`description`	string	optional
`laws`	Law	repeated

resources/livemap/coords.proto

resources.livemap.Coords

Field	Type	Label	Description
`x`	double
`y`	double

resources/livemap/heatmap/heatmap.proto

resources.livemap.heatmap.HeatmapEntry

Field	Type	Label	Description
`x`	double
`y`	double
`w`	double

resources/livemap/markers/marker_marker.proto

resources.livemap.markers.CircleMarker

Field	Type	Label
`radius`	int32
`opacity`	float	optional
`stroke`	bool	optional
`stroke_width`	int32	optional
`blink`	bool	optional

resources.livemap.markers.IconMarker

Field	Type	Label	Description
`icon`	string

resources.livemap.markers.MarkerData

Field	Type	Label	Description
`circle`	CircleMarker
`icon`	IconMarker
`rectangle`	RectangleMarker
`polygon`	PolygonMarker
`polyline`	PolylineMarker

resources.livemap.markers.MarkerMarker

Field	Type	Label
`id`	int64
`x`	double
`y`	double
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`expires_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`name`	string
`description`	string	optional
`postal`	string	optional
`color`	string	optional
`job`	string
`job_label`	string
`public`	bool	optional
`type`	MarkerType
`data`	MarkerData
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional

resources.livemap.markers.PolygonMarker

Field	Type	Label	Description
`points`	resources.livemap.Coords	repeated
`opacity`	float	optional

resources.livemap.markers.PolylineMarker

Field	Type	Label	Description
`points`	resources.livemap.Coords	repeated

resources.livemap.markers.RectangleMarker

Field	Type	Label
`end_x`	double
`end_y`	double
`opacity`	float	optional

resources.livemap.markers.MarkerType

Name	Number	Description
`MARKER_TYPE_UNSPECIFIED`	0
`MARKER_TYPE_DOT`	1
`MARKER_TYPE_CIRCLE`	2
`MARKER_TYPE_ICON`	3
`MARKER_TYPE_RECTANGLE`	4
`MARKER_TYPE_POLYGON`	5
`MARKER_TYPE_POLYLINE`	6

resources/livemap/markers/user_marker.proto

resources.livemap.markers.NameOverride

Field	Type	Label	Description
`firstname`	string
`lastname`	string

resources.livemap.markers.UserMarker

Field	Type	Label
`user_id`	int32
`x`	double
`y`	double
`updated_at`	resources.timestamp.Timestamp	optional
`postal`	string	optional
`color`	string	optional
`job`	string
`job_label`	string
`job_grade`	int32	optional
`user`	resources.jobs.colleagues.Colleague
`unit_id`	int64	optional
`unit`	resources.centrum.units.Unit	optional
`hidden`	bool
`data`	UserMarkerData	optional

resources.livemap.markers.UserMarkerData

Field	Type	Label
`name_override`	NameOverride	optional
`is_in_vehicle`	bool
`vehicle_plate`	string	optional
`vehicle_updated_at`	resources.timestamp.Timestamp	optional

resources/mailer/access/access.proto

resources.mailer.access.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_READ`	2
`ACCESS_LEVEL_WRITE`	3
`ACCESS_LEVEL_MANAGE`	4

resources/mailer/settings/settings.proto

resources.mailer.settings.EmailSettings

Field	Type	Label
`email_id`	int64
`signature`	resources.common.content.Content	optional
`blocked_emails`	string	repeated

resources/mailer/emails/email.proto

resources.mailer.emails.Email

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`deactivated`	bool
`job`	string	optional
`user_id`	int32	optional
`user`	resources.users.short.UserShort	optional
`email`	string
`email_changed`	resources.timestamp.Timestamp	optional
`label`	string	optional
`access`	resources.access.Access
`settings`	resources.mailer.settings.EmailSettings	optional

resources/mailer/messages/message.proto

resources.mailer.messages.Message

Field	Type	Label
`id`	int64
`thread_id`	int64
`sender_id`	int64
`sender`	resources.mailer.emails.Email	optional
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`title`	string
`content`	resources.common.content.Content
`data`	MessageData	optional
`creator_id`	int32	optional
`creator_job`	string	optional

resources.mailer.messages.MessageAttachment

Field	Type	Label	Description
`document`	MessageAttachmentDocument

resources.mailer.messages.MessageAttachmentDocument

Field	Type	Label	Description
`id`	int64
`title`	string	optional

resources.mailer.messages.MessageData

Field	Type	Label	Description
`attachments`	MessageAttachment	repeated

resources/mailer/threads/thread.proto

resources.mailer.threads.Thread

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`creator_email_id`	int64
`creator_email`	resources.mailer.emails.Email	optional
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`title`	string
`recipients`	ThreadRecipientEmail	repeated
`state`	ThreadState	optional

resources.mailer.threads.ThreadRecipientEmail

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`target_id`	int64
`email_id`	int64
`email`	resources.mailer.emails.Email	optional

resources.mailer.threads.ThreadState

Field	Type	Label
`thread_id`	int64
`email_id`	int64
`last_read`	resources.timestamp.Timestamp	optional
`unread`	bool	optional
`important`	bool	optional
`favorite`	bool	optional
`muted`	bool	optional
`archived`	bool	optional

resources/mailer/events/events.proto

resources.mailer.events.MailerEvent

Field	Type	Label	Description
`email_update`	resources.mailer.emails.Email
`email_delete`	int64
`email_settings_updated`	resources.mailer.settings.EmailSettings
`thread_update`	resources.mailer.threads.Thread
`thread_delete`	int64
`thread_state_update`	resources.mailer.threads.ThreadState
`message_update`	resources.mailer.messages.Message
`message_delete`	int64

resources/mailer/templates/template.proto

resources.mailer.templates.Template

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`email_id`	int64
`title`	string
`content`	resources.common.content.Content
`creator_job`	string	optional
`creator_id`	int32	optional

resources/notifications/clientview/clientview.proto

resources.notifications.clientview.ClientView

Field	Type	Label	Description
`type`	ObjectType
`id`	int64	optional

resources.notifications.clientview.ObjectEvent

Field	Type	Label
`type`	ObjectType
`id`	int64	optional
`event_type`	ObjectEventType
`user_id`	int32	optional
`job`	string	optional
`data`	google.protobuf.Struct	optional

resources.notifications.clientview.ObjectEventType

Name	Number	Description
`OBJECT_EVENT_TYPE_UNSPECIFIED`	0
`OBJECT_EVENT_TYPE_UPDATED`	1
`OBJECT_EVENT_TYPE_DELETED`	2

resources.notifications.clientview.ObjectType

Name	Number	Description
`OBJECT_TYPE_UNSPECIFIED`	0
`OBJECT_TYPE_CITIZEN`	1
`OBJECT_TYPE_DOCUMENT`	2
`OBJECT_TYPE_WIKI_PAGE`	3
`OBJECT_TYPE_JOBS_COLLEAGUE`	4
`OBJECT_TYPE_JOBS_CONDUCT`	5

resources/notifications/notifications.proto

resources.notifications.CalendarData

Field	Type	Label	Description
`calendar_id`	int64	optional
`calendar_entry_id`	int64	optional

resources.notifications.Data

Field	Type	Label
`link`	Link	optional
`caused_by`	resources.users.short.UserShort	optional
`calendar`	CalendarData	optional

resources.notifications.Link

Field	Type	Label
`to`	string
`title`	string	optional
`external`	bool	optional

resources.notifications.Notification

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`read_at`	resources.timestamp.Timestamp
`user_id`	int32
`title`	resources.common.I18NItem
`type`	NotificationType
`content`	resources.common.I18NItem
`category`	NotificationCategory
`data`	Data	optional
`starred`	bool	optional

resources.notifications.NotificationCategory

Name	Number	Description
`NOTIFICATION_CATEGORY_UNSPECIFIED`	0
`NOTIFICATION_CATEGORY_GENERAL`	1
`NOTIFICATION_CATEGORY_DOCUMENT`	2
`NOTIFICATION_CATEGORY_CALENDAR`	3

resources.notifications.NotificationType

Name	Number	Description
`NOTIFICATION_TYPE_UNSPECIFIED`	0
`NOTIFICATION_TYPE_ERROR`	1
`NOTIFICATION_TYPE_WARNING`	2
`NOTIFICATION_TYPE_INFO`	3
`NOTIFICATION_TYPE_SUCCESS`	4

resources/userinfo/userinfo.proto

resources.userinfo.AccountGroupsChanged

AccountGroupsChanged used to signal live account group changes.

Field	Type	Description
`account_id`	int64	The account the user belongs to
`changed_at`	resources.timestamp.Timestamp	Timestamp of when the change was detected
`new_groups`	resources.accounts.AccountGroups	New account groups
`can_be_superuser`	bool	Whether the account can enter superuser mode after the change
`can_be_config_admin`	bool	Whether the account can access config-admin gated screens and RPCs after the change

resources.userinfo.OriginalJob

Field	Type	Label	Description
`job`	string
`job_grade`	int32

resources.userinfo.PollReq

PollReq: published to userinfo.poll.request when an active user connects or requests a refresh.

Field	Type	Label	Description
`account_id`	int64		The account the user belongs to
`user_id`	int32		The unique user identifier within the account

resources.userinfo.UserInfo

Field	Type	Label
`account_id`	int64
`enabled`	bool
`license`	string
`last_char`	int32	optional
`user_id`	int32
`job`	string
`job_grade`	int32
`groups`	resources.accounts.AccountGroups	optional
`can_be_superuser`	bool
`superuser`	bool
`can_be_config_admin`	bool
`original_job`	OriginalJob	optional

resources.userinfo.UserInfoChanged

UserInfoChanged used to signal live primary job or job grade changes.

Field	Type	Label	Description
`account_id`	int64		The account the user belongs to
`user_id`	int32		The unique user identifier within the account
`changed_at`	resources.timestamp.Timestamp		Timestamp of when the change was detected
`new_job`	string	optional	New job title
`new_job_label`	string	optional
`new_job_grade`	int32	optional	New job grade
`new_job_grade_label`	string	optional	New job grade label

resources/notifications/events/events.proto

resources.notifications.events.JobEvent

Job related events

Field	Type	Label	Description
`job_props`	resources.jobs.props.JobProps

resources.notifications.events.JobGradeEvent

Job grade events

Field	Type	Label	Description
`refresh_token`	bool

resources.notifications.events.SystemEvent

System related events

Field	Type	Label	Description
`client_config`	resources.clientconfig.ClientConfig		Client configuration update (e.g., feature gates, game settings, banner message)
`laws_changed`	bool		Law book/Laws changes to have the client invalidate the locally cached data.

resources.notifications.events.UserEvent

User related events

Field	Type	Description
`refresh_token`	bool
`notification`	resources.notifications.Notification	Notifications
`notifications_read_count`	int64
`user_info_changed`	resources.userinfo.UserInfoChanged
`account_groups_changed`	resources.userinfo.AccountGroupsChanged

resources/permissions/events/events.proto

resources.permissions.events.JobLimitsUpdatedEvent

Field	Type	Label	Description
`job`	string

resources.permissions.events.RoleIDEvent

Field	Type	Label	Description
`role_id`	int64
`job`	string
`grade`	int32

resources/permissions/permissions/permissions.proto

resources.permissions.permissions.PermItem

Field	Type	Label	Description
`id`	int64
`val`	bool

resources.permissions.permissions.Permission

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`namespace`	string
`service`	string
`name`	string
`guard_name`	string
`val`	bool
`order`	int32	optional
`icon`	string	optional

resources.permissions.permissions.Role

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`job`	string
`job_label`	string	optional
`grade`	int32
`job_grade_label`	string	optional
`permissions`	Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

resources/qualifications/access/access.proto

resources.qualifications.access.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_VIEW`	2
`ACCESS_LEVEL_REQUEST`	3
`ACCESS_LEVEL_TAKE`	4
`ACCESS_LEVEL_GRADE`	5
`ACCESS_LEVEL_EDIT`	6

resources/qualifications/exam/exam.proto

resources.qualifications.exam.ExamGrading

Field	Type	Label	Description
`responses`	ExamGradingResponse	repeated

resources.qualifications.exam.ExamGradingResponse

Field	Type	Label
`question_id`	int64
`points`	float
`checked`	bool	optional

resources.qualifications.exam.ExamQuestion

Field	Type	Label
`id`	int64
`qualification_id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`title`	string
`description`	string	optional
`data`	ExamQuestionData
`answer`	ExamQuestionAnswerData	optional
`points`	int32	optional
`order`	int32

resources.qualifications.exam.ExamQuestionAnswerData

Field	Type	Label	Description
`answer_key`	string
`yesno`	ExamResponseYesNo
`free_text`	ExamResponseText
`single_choice`	ExamResponseSingleChoice
`multiple_choice`	ExamResponseMultipleChoice

resources.qualifications.exam.ExamQuestionData

Field	Type	Label	Description
`separator`	ExamQuestionSeparator
`image`	ExamQuestionImage
`yesno`	ExamQuestionYesNo
`free_text`	ExamQuestionText
`single_choice`	ExamQuestionSingleChoice
`multiple_choice`	ExamQuestionMultipleChoice

resources.qualifications.exam.ExamQuestionImage

Field	Type	Label	Description
`image`	resources.file.File
`alt`	string	optional

resources.qualifications.exam.ExamQuestionMultipleChoice

Field	Type	Label	Description
`choices`	string	repeated
`limit`	int32	optional

resources.qualifications.exam.ExamQuestionSeparator

resources.qualifications.exam.ExamQuestionSingleChoice

Field	Type	Label	Description
`choices`	string	repeated

resources.qualifications.exam.ExamQuestionText

Field	Type	Label	Description
`min_length`	int32
`max_length`	int32

resources.qualifications.exam.ExamQuestionYesNo

resources.qualifications.exam.ExamQuestions

Field	Type	Label	Description
`questions`	ExamQuestion	repeated

resources.qualifications.exam.ExamResponse

Field	Type	Label	Description
`question_id`	int64
`user_id`	int32
`question`	ExamQuestion
`response`	ExamResponseData

resources.qualifications.exam.ExamResponseData

Field	Type	Label	Description
`separator`	ExamResponseSeparator
`yesno`	ExamResponseYesNo
`free_text`	ExamResponseText
`single_choice`	ExamResponseSingleChoice
`multiple_choice`	ExamResponseMultipleChoice

resources.qualifications.exam.ExamResponseMultipleChoice

Field	Type	Label	Description
`choices`	string	repeated

resources.qualifications.exam.ExamResponseSeparator

resources.qualifications.exam.ExamResponseSingleChoice

Field	Type	Label	Description
`choice`	string

resources.qualifications.exam.ExamResponseText

Field	Type	Label	Description
`text`	string		0.5 Megabyte

resources.qualifications.exam.ExamResponseYesNo

Field	Type	Label	Description
`value`	bool

resources.qualifications.exam.ExamResponses

Field	Type	Label
`qualification_id`	int64
`user_id`	int32
`responses`	ExamResponse	repeated

resources.qualifications.exam.ExamUser

Field	Type	Label
`qualification_id`	int64
`user_id`	int32
`created_at`	resources.timestamp.Timestamp	optional
`started_at`	resources.timestamp.Timestamp	optional
`ends_at`	resources.timestamp.Timestamp	optional
`ended_at`	resources.timestamp.Timestamp	optional

resources.qualifications.exam.QualificationExamSettings

Field	Type	Label	Description
`time`	google.protobuf.Duration
`auto_grade`	bool
`auto_grade_mode`	AutoGradeMode
`minimum_points`	int32

resources.qualifications.exam.AutoGradeMode

Name	Number	Description
`AUTO_GRADE_MODE_UNSPECIFIED`	0
`AUTO_GRADE_MODE_STRICT`	1
`AUTO_GRADE_MODE_PARTIAL_CREDIT`	2

resources.qualifications.exam.QualificationExamMode

Name	Number	Description
`QUALIFICATION_EXAM_MODE_UNSPECIFIED`	0
`QUALIFICATION_EXAM_MODE_DISABLED`	1
`QUALIFICATION_EXAM_MODE_REQUEST_NEEDED`	2
`QUALIFICATION_EXAM_MODE_ENABLED`	3

resources/qualifications/qualifications.proto

resources.qualifications.Qualification

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`job`	string
`weight`	uint32
`closed`	bool
`draft`	bool
`public`	bool
`abbreviation`	string
`title`	string
`description`	string	optional
`content`	resources.common.content.Content
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`access`	resources.access.Access
`requirements`	QualificationRequirement	repeated
`discord_sync_enabled`	bool
`discord_settings`	QualificationDiscordSettings	optional
`exam_mode`	exam.QualificationExamMode
`exam_settings`	exam.QualificationExamSettings	optional
`exam`	exam.ExamQuestions	optional
`result`	QualificationResult	optional
`request`	QualificationRequest	optional
`label_sync_enabled`	bool
`label_sync_format`	string	optional
`files`	resources.file.File	repeated

resources.qualifications.QualificationDiscordSettings

Field	Type	Label	Description
`role_name`	string	optional
`role_format`	string	optional

resources.qualifications.QualificationRequest

Field	Type	Label
`created_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`qualification_id`	int64
`qualification`	QualificationShort	optional
`user_id`	int32
`user`	resources.users.short.UserShort
`user_comment`	string	optional
`status`	RequestStatus	optional
`approved_at`	resources.timestamp.Timestamp	optional
`approver_comment`	string	optional
`approver_id`	int32	optional
`approver`	resources.users.short.UserShort	optional
`approver_job`	string	optional

resources.qualifications.QualificationRequirement

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`qualification_id`	int64
`target_qualification_id`	int64
`target_qualification`	QualificationShort	optional

resources.qualifications.QualificationResult

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`qualification_id`	int64
`qualification`	QualificationShort	optional
`user_id`	int32
`user`	resources.users.short.UserShort
`status`	ResultStatus
`score`	float	optional
`summary`	string
`creator_id`	int32
`creator`	resources.users.short.UserShort
`creator_job`	string

resources.qualifications.QualificationShort

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`job`	string
`weight`	uint32
`closed`	bool
`draft`	bool
`public`	bool
`abbreviation`	string
`title`	string
`description`	string	optional
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`requirements`	QualificationRequirement	repeated
`exam_mode`	exam.QualificationExamMode
`exam_settings`	exam.QualificationExamSettings	optional
`result`	QualificationResult	optional

resources.qualifications.RequestStatus

Name	Number	Description
`REQUEST_STATUS_UNSPECIFIED`	0
`REQUEST_STATUS_PENDING`	1
`REQUEST_STATUS_DENIED`	2
`REQUEST_STATUS_ACCEPTED`	3
`REQUEST_STATUS_EXAM_STARTED`	4
`REQUEST_STATUS_EXAM_GRADING`	5
`REQUEST_STATUS_COMPLETED`	6

resources.qualifications.ResultStatus

Name	Number	Description
`RESULT_STATUS_UNSPECIFIED`	0
`RESULT_STATUS_PENDING`	1
`RESULT_STATUS_FAILED`	2
`RESULT_STATUS_SUCCESSFUL`	3

resources/settings/perms.proto

resources.settings.AttrsUpdate

Field	Type	Label	Description
`to_update`	resources.permissions.attributes.RoleAttribute	repeated
`to_remove`	resources.permissions.attributes.RoleAttribute	repeated

resources.settings.PermsUpdate

Field	Type	Label	Description
`to_update`	resources.permissions.permissions.PermItem	repeated
`to_remove`	resources.permissions.permissions.PermItem	repeated

resources/settings/status.proto

resources.settings.DBSyncStatus

Field	Type	Label
`enabled`	bool
`last_synced_data`	resources.timestamp.Timestamp	optional
`last_synced_activity`	resources.timestamp.Timestamp	optional
`last_dbsync_version`	string	optional

resources.settings.Database

Field	Type	Label	Description
`version`	string
`connected`	bool
`migration_version`	uint64
`migration_dirty`	bool
`db_charset`	string
`db_collation`	string
`tables_ok`	bool

resources.settings.Nats

Field	Type	Label	Description
`version`	string
`connected`	bool

resources.settings.NewVersionInfo

Field	Type	Label
`version`	string
`url`	string
`release_date`	resources.timestamp.Timestamp	optional

resources.settings.SystemStatus

Field	Type	Label	Description
`database`	Database
`nats`	Nats
`dbsync`	DBSyncStatus
`version`	VersionStatus

resources.settings.VersionStatus

Field	Type	Label	Description
`current`	string
`new_version`	NewVersionInfo	optional

resources/stats/stats.proto

resources.stats.CategoryValue

Field	Type	Label
`id`	int64
`job`	string
`name`	string
`color`	string	optional
`icon`	string	optional
`value`	int64

resources.stats.DailyValue

Field	Type	Label	Description
`day`	resources.timestamp.Timestamp
`value`	int64

resources.stats.KeyValue

Field	Type	Label	Description
`key`	string
`value`	int64

resources.stats.PeriodSeriesValue

Field	Type	Label	Description
`day`	resources.timestamp.Timestamp
`key`	string
`label`	string
`value`	int64

resources.stats.Stat

Field	Type	Label	Description
`value`	int32	optional

resources.stats.StatsCategory

Name	Number	Description
`STATS_CATEGORY_UNSPECIFIED`	0
`STATS_CATEGORY_CUSTOM`	1
`STATS_CATEGORY_DOCUMENTS_BY_CATEGORY`	2
`STATS_CATEGORY_TOP_LAWS`	3
`STATS_CATEGORY_PENALTIES_OVER_TIME`	4
`STATS_CATEGORY_EMPLOYEE_COUNT_OVER_TIME`	5

resources.stats.StatsPeriod

Name	Number	Description
`STATS_PERIOD_UNSPECIFIED`	0
`STATS_PERIOD_DAILY`	1
`STATS_PERIOD_WEEKLY`	2
`STATS_PERIOD_MONTHLY`	3

resources/sync/activity/activity.proto

resources.sync.activity.AccountUpdate

Field	Type	Label
`license`	string
`group`	string	optional
`groups`	resources.accounts.AccountGroups

resources.sync.activity.ColleagueProps

Field	Type	Label	Description
`reason`	string	optional
`props`	resources.jobs.colleagues.ColleagueProps

resources.sync.activity.TimeclockUpdate

Field	Type	Label	Description
`job`	string
`user_id`	int32
`start`	bool

resources.sync.activity.UserOAuth2Conn

Connect an identifier/license to the provider with the specified external id (e.g., auto discord social connect on server join)

Field	Type	Label	Description
`provider_name`	string
`identifier`	string
`external_id`	string
`username`	string

resources.sync.activity.UserProps

Field	Type	Label	Description
`reason`	string	optional
`props`	resources.users.props.UserProps

resources.sync.activity.UserUpdate

Field	Type	Label	Description
`user_id`	int32
`group`	string	optional
`job`	string	optional	Char details
`job_grade`	int32	optional
`firstname`	string	optional
`lastname`	string	optional

resources/sync/data/data.proto

resources.sync.data.CitizenLocations

Field	Type	Label
`user_id`	int32
`job`	string
`job_grade`	int32	optional
`coords`	resources.livemap.Coords
`hidden`	bool
`remove`	bool

resources.sync.data.DataAccounts

Field	Type	Label	Description
`account_updates`	resources.sync.activity.AccountUpdate	repeated
`clear`	bool

resources.sync.data.DataJobs

Field	Type	Label	Description
`jobs`	resources.jobs.Job	repeated

resources.sync.data.DataLicenses

Field	Type	Label	Description
`licenses`	resources.citizens.licenses.License	repeated

resources.sync.data.DataStatus

Field	Type	Label	Description
`count`	int64

resources.sync.data.DataUser

Detailed user information for sync purposes Should be kept inline with resources.users.User.

Field	Type	Label	Description
`user_id`	int32
`identifier`	string
`updated_at`	resources.timestamp.Timestamp	optional
`job`	string		Primary job name. When `jobs` contains entries and `job` is empty, sync API derive this value from the primary entry in `jobs`.
`job_label`	string	optional
`job_grade`	int32		Primary job grade. When `jobs` contains entries and `job_grade` is empty, sync API derive this value from the primary entry in `jobs`.
`job_grade_label`	string	optional
`jobs`	resources.users.UserJob	repeated	Full job list for the user. This is the preferred source of truth when present; sync API use the primary job entry to populate `job` / `job_grade` if those scalar fields are empty.
`firstname`	string
`lastname`	string	optional
`dateofbirth`	string
`sex`	string	optional
`height`	float	optional
`phone_number`	string	optional
`phone_numbers`	resources.users.PhoneNumber	repeated
`visum`	int32	optional
`playtime`	int32	optional
`licenses`	resources.citizens.licenses.License	repeated
`profile_picture_file_id`	int64	optional
`profile_picture`	string	optional

resources.sync.data.DataUserLocations

Field	Type	Label	Description
`users`	CitizenLocations	repeated
`clear_all`	bool	optional

resources.sync.data.DataUsers

Field	Type	Label	Description
`users`	DataUser	repeated

resources.sync.data.DataVehicles

Field	Type	Label	Description
`vehicles`	resources.vehicles.Vehicle	repeated

resources.sync.data.DeleteUsers

Field	Type	Label	Description
`user_ids`	int32	repeated

resources.sync.data.DeleteVehicles

Field	Type	Label	Description
`plates`	string	repeated

resources.sync.data.LastCharID

Field	Type	Label	Description
`license`	string
`last_char_id`	int32	optional

resources/tracker/mapping.proto

resources.tracker.UserMapping

Field	Type	Label
`user_id`	int32
`unit_id`	int64	optional
`created_at`	resources.timestamp.Timestamp
`hidden`	bool

resources/users/activity/activity.proto

resources.users.activity.CitizenDocumentRelation

Field	Type	Label	Description
`added`	bool
`document_id`	int64
`relation`	resources.documents.relations.DocRelation

resources.users.activity.FineChange

Field	Type	Label	Description
`removed`	bool
`amount`	int64

resources.users.activity.JailChange

Field	Type	Label
`seconds`	int32
`admin`	bool
`location`	string	optional

resources.users.activity.JobChange

Field	Type	Label
`job`	string	optional
`job_label`	string	optional
`grade`	int32	optional
`grade_label`	string	optional

resources.users.activity.LabelAdded

Field	Type	Label	Description
`id`	int64
`expires_at`	resources.timestamp.Timestamp	optional

resources.users.activity.LabelsChange

Field	Type	Label	Description
`added`	resources.citizens.labels.Label	repeated	Deprecated.
`removed`	resources.citizens.labels.Label	repeated	Deprecated.
`added_ids`	LabelAdded	repeated
`removed_ids`	int64	repeated
`expired`	bool

resources.users.activity.LicenseChange

Field	Type	Label	Description
`added`	bool		`true` if licenses were added, `false` if removed
`licenses`	resources.citizens.licenses.License	repeated

resources.users.activity.MugshotChange

Field	Type	Label	Description
`new`	string	optional

resources.users.activity.NameChange

Field	Type	Label	Description
`old`	string
`new`	string

resources.users.activity.TrafficInfractionPointsChange

Field	Type	Label	Description
`old`	uint32
`new`	uint32

resources.users.activity.UserActivity

Field	Type	Label
`id`	int64
`type`	UserActivityType
`created_at`	resources.timestamp.Timestamp
`source_user_id`	int32	optional
`source_user`	resources.users.short.UserShort	optional
`target_user_id`	int32
`target_user`	resources.users.short.UserShort
`key`	string
`reason`	string
`data`	UserActivityData	optional
`old_value`	string
`new_value`	string

resources.users.activity.UserActivityData

Field	Type	Description
`name_change`	NameChange
`licenses_change`	LicenseChange
`wanted_change`	WantedChange	User Props
`traffic_infraction_points_change`	TrafficInfractionPointsChange
`mugshot_change`	MugshotChange
`labels_change`	LabelsChange
`job_change`	JobChange
`document_relation`	CitizenDocumentRelation	Docstore related
`jail_change`	JailChange	"Plugin" activities
`fine_change`	FineChange

resources.users.activity.WantedChange

Field	Type	Label	Description
`wanted`	bool
`auto`	bool

resources.users.activity.UserActivityType

Name	Number	Description
`USER_ACTIVITY_TYPE_UNSPECIFIED`	0
`USER_ACTIVITY_TYPE_NAME`	4	Name change
`USER_ACTIVITY_TYPE_LICENSES`	5	License(s) change added/removed
`USER_ACTIVITY_TYPE_WANTED`	6	Wanted status change
`USER_ACTIVITY_TYPE_TRAFFIC_INFRACTION_POINTS`	7
`USER_ACTIVITY_TYPE_MUGSHOT`	8
`USER_ACTIVITY_TYPE_LABELS`	9
`USER_ACTIVITY_TYPE_JOB`	10
`USER_ACTIVITY_TYPE_DOCUMENT`	11
`USER_ACTIVITY_TYPE_JAIL`	12
`USER_ACTIVITY_TYPE_FINE`	13

resources/vehicles/activity/activity.proto

resources.vehicles.activity.VehicleActivity

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp	optional
`plate`	string
`activity_type`	VehicleActivityType
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`reason`	string	optional
`data`	VehicleActivityData	optional

resources.vehicles.activity.VehicleActivityData

Field	Type	Label	Description
`wanted_change`	WantedChange

resources.vehicles.activity.WantedChange

Field	Type	Label
`wanted`	bool
`previous_wanted`	bool	optional
`wanted_reason`	string	optional
`wanted_at`	resources.timestamp.Timestamp	optional
`wanted_till`	resources.timestamp.Timestamp	optional
`auto`	bool

resources.vehicles.activity.VehicleActivityType

Name	Number	Description
`VEHICLE_ACTIVITY_TYPE_UNSPECIFIED`	0
`VEHICLE_ACTIVITY_TYPE_WANTED`	1	Types for `VehicleActivityData`

resources/wiki/access/access.proto

resources.wiki.access.AccessLevel

Name	Number	Description
`ACCESS_LEVEL_UNSPECIFIED`	0
`ACCESS_LEVEL_BLOCKED`	1
`ACCESS_LEVEL_VIEW`	2
`ACCESS_LEVEL_ACCESS`	3
`ACCESS_LEVEL_EDIT`	4

resources/wiki/activity/activity.proto

resources.wiki.activity.PageAccessJobsDiff

Field	Type	Label
`to_create`	resources.access.JobAccess	repeated
`to_update`	resources.access.JobAccess	repeated
`to_delete`	resources.access.JobAccess	repeated

resources.wiki.activity.PageAccessUpdated

Field	Type	Label	Description
`jobs`	PageAccessJobsDiff
`users`	PageAccessUsersDiff

resources.wiki.activity.PageAccessUsersDiff

Field	Type	Label
`to_create`	resources.access.UserAccess	repeated
`to_update`	resources.access.UserAccess	repeated
`to_delete`	resources.access.UserAccess	repeated

resources.wiki.activity.PageActivity

Field	Type	Label
`id`	int64
`created_at`	resources.timestamp.Timestamp
`page_id`	int64
`activity_type`	PageActivityType
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`creator_job`	string
`creator_job_label`	string	optional
`reason`	string	optional
`data`	PageActivityData

resources.wiki.activity.PageActivityData

Field	Type	Label	Description
`updated`	PageUpdated
`access_updated`	PageAccessUpdated

resources.wiki.activity.PageFilesChange

Field	Type	Label	Description
`added`	int64
`deleted`	int64

resources.wiki.activity.PageUpdated

Field	Type	Label
`title_diff`	string	optional
`title_cdiff`	resources.common.content.ContentDiff	optional
`description_diff`	string	optional
`description_cdiff`	resources.common.content.ContentDiff	optional
`content_diff`	string	optional
`content_cdiff`	resources.common.content.ContentDiff	optional
`files_change`	PageFilesChange	optional

resources.wiki.activity.PageActivityType

Name	Number	Description
`PAGE_ACTIVITY_TYPE_UNSPECIFIED`	0
`PAGE_ACTIVITY_TYPE_CREATED`	1	Base
`PAGE_ACTIVITY_TYPE_UPDATED`	2
`PAGE_ACTIVITY_TYPE_ACCESS_UPDATED`	3
`PAGE_ACTIVITY_TYPE_OWNER_CHANGED`	4
`PAGE_ACTIVITY_TYPE_DELETED`	5
`PAGE_ACTIVITY_TYPE_DRAFT_TOGGLED`	6

resources/wiki/page.proto

resources.wiki.Page

Field	Type	Label
`id`	int64
`job`	string
`job_label`	string	optional
`parent_id`	int64	optional
`meta`	PageMeta
`content`	resources.common.content.Content
`access`	resources.access.Access
`files`	resources.file.File	repeated

resources.wiki.PageMeta

Field	Type	Label
`created_at`	resources.timestamp.Timestamp
`updated_at`	resources.timestamp.Timestamp	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`slug`	string	optional
`title`	string
`description`	string
`creator_id`	int32	optional
`creator`	resources.users.short.UserShort	optional
`content_type`	resources.common.content.ContentType
`tags`	string	repeated
`toc`	bool	optional
`public`	bool
`draft`	bool
`startpage`	bool

resources.wiki.PageRootInfo

Field	Type	Label	Description
`logo_file_id`	int64	optional
`logo`	resources.file.File	optional

resources.wiki.PageShort

Field	Type	Label
`id`	int64
`job`	string
`job_label`	string	optional
`parent_id`	int64	optional
`deleted_at`	resources.timestamp.Timestamp	optional
`slug`	string	optional
`title`	string
`description`	string
`children`	PageShort	repeated
`root_info`	PageRootInfo	optional
`level`	int32	optional
`draft`	bool
`startpage`	bool

services/auth/auth.proto

services.auth.ChangePasswordRequest

Field	Type	Label	Description
`current_password`	string
`new_password`	string

services.auth.ChangePasswordResponse

services.auth.ChangeUsernameRequest

Field	Type	Label	Description
`current_username`	string
`new_username`	string

services.auth.ChangeUsernameResponse

services.auth.ChooseCharacterRequest

Field	Type	Label	Description
`char_id`	int32

services.auth.ChooseCharacterResponse

Field	Type	Label
`token`	string
`username`	string
`expires`	resources.timestamp.Timestamp
`job_props`	resources.jobs.props.JobProps
`char`	resources.users.User
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

services.auth.CreateAccountRequest

Field	Type	Label	Description
`reg_token`	string
`username`	string
`password`	string

services.auth.CreateAccountResponse

Field	Type	Label	Description
`account_id`	int64

services.auth.DeleteSocialLoginRequest

Field	Type	Label	Description
`provider`	string

services.auth.DeleteSocialLoginResponse

Field	Type	Label	Description
`success`	bool

services.auth.ForgotPasswordRequest

Field	Type	Label	Description
`reg_token`	string
`new`	string

services.auth.ForgotPasswordResponse

services.auth.GetAccountInfoRequest

services.auth.GetAccountInfoResponse

Field	Type	Label
`account`	resources.accounts.Account
`oauth2_providers`	resources.accounts.oauth2.OAuth2Provider	repeated
`oauth2_connections`	resources.accounts.oauth2.OAuth2Account	repeated

services.auth.GetCharactersRequest

services.auth.GetCharactersResponse

Field	Type	Label	Description
`chars`	resources.accounts.Character	repeated

services.auth.ImpersonateJobRequest

Field	Type	Label	Description
`job_grade`	int32

services.auth.ImpersonateJobResponse

Field	Type	Label
`token`	string
`expires`	resources.timestamp.Timestamp
`char`	resources.users.User
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated
`state`	bool

services.auth.LoginRequest

Field	Type	Label	Description
`username`	string
`password`	string

services.auth.LoginResponse

Field	Type	Label
`expires`	resources.timestamp.Timestamp
`account_id`	int64
`char`	ChooseCharacterResponse	optional

services.auth.LogoutResponse

Field	Type	Label	Description
`success`	bool

services.auth.RefreshAccountSessionRequest

services.auth.RefreshAccountSessionResponse

Field	Type	Label	Description
`expires`	resources.timestamp.Timestamp
`account_id`	int64
`username`	string
`can_be_config_admin`	bool

services.auth.SetSuperuserModeRequest

Field	Type	Label	Description
`superuser`	bool
`job`	string	optional

services.auth.SetSuperuserModeResponse

Field	Type	Label
`token`	string
`expires`	resources.timestamp.Timestamp
`job_props`	resources.jobs.props.JobProps	optional
`char`	resources.users.User
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

services.auth.AuthService

Auth Service handles user authentication, character selection and oauth2 connections Some methods must be caled via HTTP-based GRPC web request to allow cookies to be set/unset.

Method Name	Request Type	Response Type
`Login`	LoginRequest	LoginResponse
`Logout`	LogoutRequest	LogoutResponse
`CreateAccount`	CreateAccountRequest	CreateAccountResponse
`ChangeUsername`	ChangeUsernameRequest	ChangeUsernameResponse
`ChangePassword`	ChangePasswordRequest	ChangePasswordResponse
`ForgotPassword`	ForgotPasswordRequest	ForgotPasswordResponse
`GetCharacters`	GetCharactersRequest	GetCharactersResponse
`ChooseCharacter`	ChooseCharacterRequest	ChooseCharacterResponse
`ImpersonateJob`	ImpersonateJobRequest	ImpersonateJobResponse
`GetAccountInfo`	GetAccountInfoRequest	GetAccountInfoResponse
`RefreshAccountSession`	RefreshAccountSessionRequest	RefreshAccountSessionResponse
`DeleteSocialLogin`	DeleteSocialLoginRequest	DeleteSocialLoginResponse
`SetSuperuserMode`	SetSuperuserModeRequest	SetSuperuserModeResponse

services/calendar/calendar.proto

services.calendar.CreateCalendarRequest

Field	Type	Label	Description
`calendar`	resources.calendar.Calendar

services.calendar.CreateCalendarResponse

Field	Type	Label	Description
`calendar`	resources.calendar.Calendar

services.calendar.DeleteCalendarRequest

Field	Type	Label	Description
`calendar_id`	int64

services.calendar.DeleteCalendarResponse

services.calendar.GetCalendarRequest

Field	Type	Label	Description
`calendar_id`	int64

services.calendar.GetCalendarResponse

Field	Type	Label	Description
`calendar`	resources.calendar.Calendar

services.calendar.ListCalendarsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`only_public`	bool		Search params
`min_access_level`	resources.calendar.access.AccessLevel	optional
`after`	resources.timestamp.Timestamp	optional
`calendar_ids`	int64	repeated

services.calendar.ListCalendarsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`calendars`	resources.calendar.Calendar	repeated

services.calendar.ListSubscriptionsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest

services.calendar.ListSubscriptionsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`subs`	resources.calendar.CalendarSub	repeated

services.calendar.SubscribeToCalendarRequest

Field	Type	Label	Description
`sub`	resources.calendar.CalendarSub
`delete`	bool

services.calendar.SubscribeToCalendarResponse

Field	Type	Label	Description
`sub`	resources.calendar.CalendarSub

services.calendar.UpdateCalendarRequest

Field	Type	Label	Description
`calendar`	resources.calendar.Calendar

services.calendar.UpdateCalendarResponse

Field	Type	Label	Description
`calendar`	resources.calendar.Calendar

services.calendar.CalendarService

Method Name	Request Type	Response Type
`ListCalendars`	ListCalendarsRequest	ListCalendarsResponse
`GetCalendar`	GetCalendarRequest	GetCalendarResponse
`CreateCalendar`	CreateCalendarRequest	CreateCalendarResponse
`UpdateCalendar`	UpdateCalendarRequest	UpdateCalendarResponse
`DeleteCalendar`	DeleteCalendarRequest	DeleteCalendarResponse
`ListSubscriptions`	ListSubscriptionsRequest	ListSubscriptionsResponse
`SubscribeToCalendar`	SubscribeToCalendarRequest	SubscribeToCalendarResponse

services/calendar/entries.proto

services.calendar.CreateOrUpdateCalendarEntryRequest

Field	Type	Label	Description
`entry`	resources.calendar.entries.CalendarEntry
`user_ids`	int32	repeated

services.calendar.CreateOrUpdateCalendarEntryResponse

Field	Type	Label	Description
`entry`	resources.calendar.entries.CalendarEntry

services.calendar.DeleteCalendarEntryRequest

Field	Type	Label	Description
`entry_id`	int64

services.calendar.DeleteCalendarEntryResponse

services.calendar.GetCalendarEntryRequest

Field	Type	Label	Description
`entry_id`	int64

services.calendar.GetCalendarEntryResponse

Field	Type	Label	Description
`entry`	resources.calendar.entries.CalendarEntry

services.calendar.GetUpcomingEntriesRequest

Field	Type	Label	Description
`seconds`	int32

services.calendar.GetUpcomingEntriesResponse

Field	Type	Label	Description
`entries`	resources.calendar.entries.CalendarEntry	repeated

services.calendar.ListCalendarEntriesRequest

Field	Type	Label
`year`	int32
`month`	int32
`calendar_ids`	int64	repeated
`show_hidden`	bool	optional
`after`	resources.timestamp.Timestamp	optional

services.calendar.ListCalendarEntriesResponse

Field	Type	Label	Description
`entries`	resources.calendar.entries.CalendarEntry	repeated

services.calendar.ListCalendarEntryRSVPRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`entry_id`	int64

services.calendar.ListCalendarEntryRSVPResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`entries`	resources.calendar.entries.CalendarEntryRSVP	repeated

services.calendar.RSVPCalendarEntryRequest

Field	Type	Label
`entry`	resources.calendar.entries.CalendarEntryRSVP
`subscribe`	bool
`remove`	bool	optional
`occurrence_key`	string	optional

services.calendar.RSVPCalendarEntryResponse

Field	Type	Label	Description
`entry`	resources.calendar.entries.CalendarEntryRSVP	optional

services.calendar.ShareCalendarEntryRequest

Field	Type	Label	Description
`entry_id`	int64
`user_ids`	int32	repeated

services.calendar.ShareCalendarEntryResponse

services.calendar.EntriesService

Method Name	Request Type	Response Type
`ListCalendarEntries`	ListCalendarEntriesRequest	ListCalendarEntriesResponse
`GetUpcomingEntries`	GetUpcomingEntriesRequest	GetUpcomingEntriesResponse
`GetCalendarEntry`	GetCalendarEntryRequest	GetCalendarEntryResponse
`CreateOrUpdateCalendarEntry`	CreateOrUpdateCalendarEntryRequest	CreateOrUpdateCalendarEntryResponse
`DeleteCalendarEntry`	DeleteCalendarEntryRequest	DeleteCalendarEntryResponse
`ShareCalendarEntry`	ShareCalendarEntryRequest	ShareCalendarEntryResponse
`ListCalendarEntryRSVP`	ListCalendarEntryRSVPRequest	ListCalendarEntryRSVPResponse
`RSVPCalendarEntry`	RSVPCalendarEntryRequest	RSVPCalendarEntryResponse

services/centrum/centrum.proto

services.centrum.GetDispatchHeatmapRequest

services.centrum.GetDispatchHeatmapResponse

Field	Type	Label	Description
`max_entries`	int32
`entries`	resources.livemap.heatmap.HeatmapEntry	repeated

services.centrum.GetSettingsRequest

services.centrum.GetSettingsResponse

Field	Type	Label	Description
`settings`	resources.centrum.settings.Settings
`effective_access`	resources.centrum.settings.EffectiveAccess

services.centrum.LatestState

Field	Type	Label	Description
`dispatchers`	resources.centrum.dispatchers.JobDispatchers
`own_unit_id`	int64	optional
`units`	resources.centrum.units.Unit	repeated	Send the current units and dispatches
`dispatches`	resources.centrum.dispatches.Dispatch	repeated

services.centrum.StreamHandshake

Field	Type	Label	Description
`server_time`	resources.timestamp.Timestamp
`settings`	resources.centrum.settings.Settings
`access`	resources.centrum.settings.EffectiveAccess

services.centrum.StreamRequest

services.centrum.StreamResponse

Field	Type	Label	Description
`handshake`	StreamHandshake
`latest_state`	LatestState
`settings`	resources.centrum.settings.Settings
`access`	resources.centrum.settings.EffectiveAccess
`dispatchers`	resources.centrum.dispatchers.Dispatchers
`unit_deleted`	int64
`unit_updated`	resources.centrum.units.Unit
`unit_status`	resources.centrum.units.UnitStatus
`dispatch_deleted`	int64
`dispatch_updated`	resources.centrum.dispatches.Dispatch
`dispatch_status`	resources.centrum.dispatches.DispatchStatus

services.centrum.TakeControlRequest

Field	Type	Label	Description
`signon`	bool

services.centrum.TakeControlResponse

services.centrum.UpdateDispatchersRequest

Field	Type	Label	Description
`to_remove`	int32	repeated

services.centrum.UpdateDispatchersResponse

Field	Type	Label	Description
`dispatchers`	resources.centrum.dispatchers.Dispatchers

services.centrum.UpdateSettingsRequest

Field	Type	Label	Description
`settings`	resources.centrum.settings.Settings

services.centrum.UpdateSettingsResponse

Field	Type	Label	Description
`settings`	resources.centrum.settings.Settings

services.centrum.CentrumService

Method Name	Request Type	Response Type
`GetSettings`	GetSettingsRequest	GetSettingsResponse
`UpdateSettings`	UpdateSettingsRequest	UpdateSettingsResponse
`GetDispatchHeatmap`	GetDispatchHeatmapRequest	GetDispatchHeatmapResponse
`TakeControl`	TakeControlRequest	TakeControlResponse
`UpdateDispatchers`	UpdateDispatchersRequest	UpdateDispatchersResponse
`Stream`	StreamRequest	StreamResponse stream

services/centrum/dispatches.proto

services.centrum.AssignDispatchRequest

Field	Type	Label
`dispatch_id`	int64
`to_add`	int64	repeated
`to_remove`	int64	repeated
`forced`	bool	optional

services.centrum.AssignDispatchResponse

services.centrum.CreateDispatchRequest

Field	Type	Label	Description
`dispatch`	resources.centrum.dispatches.Dispatch

services.centrum.CreateDispatchResponse

Field	Type	Label	Description
`dispatch`	resources.centrum.dispatches.Dispatch

services.centrum.DeleteDispatchRequest

Field	Type	Label	Description
`id`	int64

services.centrum.DeleteDispatchResponse

services.centrum.GetDispatchRequest

Field	Type	Label	Description
`id`	int64

services.centrum.GetDispatchResponse

Field	Type	Label	Description
`dispatch`	resources.centrum.dispatches.Dispatch

services.centrum.ListDispatchActivityRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`id`	int64

services.centrum.ListDispatchActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.centrum.dispatches.DispatchStatus	repeated

services.centrum.ListDispatchTargetJobsRequest

services.centrum.ListDispatchTargetJobsResponse

Field	Type	Label	Description
`jobs`	resources.jobs.Job	repeated

services.centrum.ListDispatchesRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`status`	resources.centrum.dispatches.StatusDispatch	repeated
`not_status`	resources.centrum.dispatches.StatusDispatch	repeated
`ids`	int64	repeated
`postal`	string	optional
`creator_ids`	int32	repeated

services.centrum.ListDispatchesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`dispatches`	resources.centrum.dispatches.Dispatch	repeated

services.centrum.TakeDispatchRequest

Field	Type	Label
`dispatch_ids`	int64	repeated
`resp`	resources.centrum.dispatches.TakeDispatchResp
`reason`	string	optional

services.centrum.TakeDispatchResponse

services.centrum.UpdateDispatchRequest

Field	Type	Label	Description
`dispatch`	resources.centrum.dispatches.Dispatch

services.centrum.UpdateDispatchResponse

Field	Type	Label	Description
`dispatch`	resources.centrum.dispatches.Dispatch

services.centrum.UpdateDispatchStatusRequest

Field	Type	Label
`dispatch_id`	int64
`status`	resources.centrum.dispatches.StatusDispatch
`reason`	string	optional
`code`	string	optional

services.centrum.UpdateDispatchStatusResponse

services.centrum.DispatchesService

Method Name	Request Type	Response Type
`CreateDispatch`	CreateDispatchRequest	CreateDispatchResponse
`UpdateDispatch`	UpdateDispatchRequest	UpdateDispatchResponse
`DeleteDispatch`	DeleteDispatchRequest	DeleteDispatchResponse
`ListDispatchTargetJobs`	ListDispatchTargetJobsRequest	ListDispatchTargetJobsResponse
`AssignDispatch`	AssignDispatchRequest	AssignDispatchResponse
`GetDispatch`	GetDispatchRequest	GetDispatchResponse
`ListDispatches`	ListDispatchesRequest	ListDispatchesResponse
`ListDispatchActivity`	ListDispatchActivityRequest	ListDispatchActivityResponse
`TakeDispatch`	TakeDispatchRequest	TakeDispatchResponse
`UpdateDispatchStatus`	UpdateDispatchStatusRequest	UpdateDispatchStatusResponse

services/centrum/units.proto

services.centrum.AssignUnitRequest

Field	Type	Label
`unit_id`	int64
`to_add`	int32	repeated
`to_remove`	int32	repeated

services.centrum.AssignUnitResponse

services.centrum.CreateOrUpdateUnitRequest

Field	Type	Label	Description
`unit`	resources.centrum.units.Unit

services.centrum.CreateOrUpdateUnitResponse

Field	Type	Label	Description
`unit`	resources.centrum.units.Unit

services.centrum.DeleteUnitRequest

Field	Type	Label	Description
`unit_id`	int64

services.centrum.DeleteUnitResponse

services.centrum.JoinUnitRequest

Field	Type	Label	Description
`unit_id`	int64	optional

services.centrum.JoinUnitResponse

Field	Type	Label	Description
`unit`	resources.centrum.units.Unit

services.centrum.ListUnitActivityRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`id`	int64

services.centrum.ListUnitActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.centrum.units.UnitStatus	repeated

services.centrum.ListUnitsRequest

Field	Type	Label	Description
`status`	resources.centrum.units.StatusUnit	repeated

services.centrum.ListUnitsResponse

Field	Type	Label	Description
`units`	resources.centrum.units.Unit	repeated

services.centrum.ReorderUnitsRequest

Field	Type	Label	Description
`unit_ids`	int64	repeated

services.centrum.ReorderUnitsResponse

services.centrum.UpdateUnitStatusRequest

Field	Type	Label
`unit_id`	int64
`status`	resources.centrum.units.StatusUnit
`reason`	string	optional
`code`	string	optional

services.centrum.UpdateUnitStatusResponse

services.centrum.UnitsService

Method Name	Request Type	Response Type
`JoinUnit`	JoinUnitRequest	JoinUnitResponse
`ListUnits`	ListUnitsRequest	ListUnitsResponse
`ListUnitActivity`	ListUnitActivityRequest	ListUnitActivityResponse
`CreateOrUpdateUnit`	CreateOrUpdateUnitRequest	CreateOrUpdateUnitResponse
`DeleteUnit`	DeleteUnitRequest	DeleteUnitResponse
`ReorderUnits`	ReorderUnitsRequest	ReorderUnitsResponse
`AssignUnit`	AssignUnitRequest	AssignUnitResponse
`UpdateUnitStatus`	UpdateUnitStatusRequest	UpdateUnitStatusResponse

services/citizens/citizens.proto

services.citizens.DeleteAvatarRequest

services.citizens.DeleteAvatarResponse

services.citizens.DeleteMugshotRequest

Field	Type	Label	Description
`user_id`	int32
`reason`	string

services.citizens.DeleteMugshotResponse

services.citizens.GetUserRequest

Field	Type	Label	Description
`user_id`	int32
`info_only`	bool	optional

services.citizens.GetUserResponse

Field	Type	Label	Description
`user`	resources.users.User

services.citizens.ListCitizensRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`search`	string		Search params
`wanted`	bool	optional
`phone_number`	string	optional
`traffic_infraction_points`	uint32	optional
`dateofbirth`	string	optional
`open_fines`	int64	optional
`min_height`	float	optional	Height range search (in cm)
`max_height`	float	optional

services.citizens.ListCitizensResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`users`	resources.users.User	repeated

services.citizens.ListUserActivityRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`user_id`	int32		Search params
`types`	resources.users.activity.UserActivityType	repeated

services.citizens.ListUserActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.users.activity.UserActivity	repeated

services.citizens.SetUserPropsRequest

Field	Type	Label	Description
`props`	resources.users.props.UserProps
`reason`	string

services.citizens.SetUserPropsResponse

Field	Type	Label	Description
`props`	resources.users.props.UserProps

services.citizens.CitizensService

Method Name	Request Type	Response Type	Description
`ListCitizens`	ListCitizensRequest	ListCitizensResponse
`GetUser`	GetUserRequest	GetUserResponse
`ListUserActivity`	ListUserActivityRequest	ListUserActivityResponse
`SetUserProps`	SetUserPropsRequest	SetUserPropsResponse
`UploadAvatar`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
`DeleteAvatar`	DeleteAvatarRequest	DeleteAvatarResponse
`UploadMugshot`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
`DeleteMugshot`	DeleteMugshotRequest	DeleteMugshotResponse

services/citizens/labels.proto

services.citizens.CreateOrUpdateLabelRequest

Field	Type	Label	Description
`label`	resources.citizens.labels.Label

services.citizens.CreateOrUpdateLabelResponse

Field	Type	Label	Description
`label`	resources.citizens.labels.Label

services.citizens.DeleteLabelRequest

Field	Type	Label	Description
`id`	int64

services.citizens.DeleteLabelResponse

services.citizens.GetLabelRequest

Field	Type	Label	Description
`id`	int64

services.citizens.GetLabelResponse

Field	Type	Label	Description
`label`	resources.citizens.labels.Label

services.citizens.ListLabelsRequest

Field	Type	Label
`search`	string	optional
`min_access`	resources.citizens.labels.AccessLevel	optional
`own_job_only`	bool	optional

services.citizens.ListLabelsResponse

Field	Type	Label	Description
`labels`	resources.citizens.labels.Label	repeated

services.citizens.ReorderLabelsRequest

Field	Type	Label	Description
`label_ids`	int64	repeated

services.citizens.ReorderLabelsResponse

services.citizens.LabelsService

Method Name	Request Type	Response Type
`ListLabels`	ListLabelsRequest	ListLabelsResponse
`GetLabel`	GetLabelRequest	GetLabelResponse
`CreateOrUpdateLabel`	CreateOrUpdateLabelRequest	CreateOrUpdateLabelResponse
`DeleteLabel`	DeleteLabelRequest	DeleteLabelResponse
`ReorderLabels`	ReorderLabelsRequest	ReorderLabelsResponse

services/completor/completor.proto

services.completor.CompleteCitizensRequest

Field	Type	Label
`search`	string
`current_job`	bool	optional
`on_duty`	bool	optional
`user_ids`	int32	repeated
`user_ids_only`	bool	optional

services.completor.CompleteCitizensResponse

Field	Type	Label	Description
`users`	resources.users.short.UserShort	repeated

services.completor.CompleteDocumentCategoriesRequest

Field	Type	Label	Description
`search`	string
`category_ids`	int64	repeated

services.completor.CompleteDocumentCategoriesResponse

Field	Type	Label	Description
`categories`	resources.documents.category.Category	repeated

services.completor.CompleteJobsRequest

Field	Type	Label
`search`	string	optional
`exact_match`	bool	optional
`current_job`	bool	optional

services.completor.CompleteJobsResponse

Field	Type	Label	Description
`jobs`	resources.jobs.Job	repeated

services.completor.ListLawBooksRequest

services.completor.ListLawBooksResponse

Field	Type	Label	Description
`books`	resources.laws.LawBook	repeated

services.completor.CompletorService

Method Name	Request Type	Response Type
`CompleteCitizens`	CompleteCitizensRequest	CompleteCitizensResponse
`CompleteJobs`	CompleteJobsRequest	CompleteJobsResponse
`CompleteDocumentCategories`	CompleteDocumentCategoriesRequest	CompleteDocumentCategoriesResponse
`ListLawBooks`	ListLawBooksRequest	ListLawBooksResponse

services/documents/approval.proto

services.documents.ApprovalTaskSeed

A declarative "ensure" for tasks under one policy/snapshot. Exactly one target must be set: user_id OR (job + minimum_grade).

Field	Type	Label	Description
`user_id`	int32		If set -> USER task; slots is forced to 1
`job`	string		If user_id == 0 -> JOB task
`minimum_grade`	int32
`label`	string	optional	Label of task
`signature_required`	bool
`slots`	int32		Only for JOB tasks; number of PENDING slots to ensure (>=1)
`due_at`	resources.timestamp.Timestamp	optional	Optional default due date for created slots
`comment`	string	optional	Optional note set on created tasks

services.documents.DecideApprovalRequest

Field	Type	Label	Description
`document_id`	int64
`task_id`	int64	optional
`new_status`	resources.documents.approval.ApprovalTaskStatus		APPROVED or DECLINED
`comment`	string
`payload_svg`	string	optional
`stamp_id`	int64	optional	When type=STAMP

services.documents.DecideApprovalResponse

Field	Type	Label	Description
`approval`	resources.documents.approval.Approval
`task`	resources.documents.approval.ApprovalTask
`policy`	resources.documents.approval.ApprovalPolicy
`doc_meta`	resources.documents.DocumentMeta

services.documents.DeleteApprovalTasksRequest

Field	Type	Label	Description
`document_id`	int64
`task_ids`	int64	repeated
`delete_all_pending`	bool		If true, ignore task_ids and delete all PENDING tasks under this policy

services.documents.DeleteApprovalTasksResponse

services.documents.ListApprovalPoliciesRequest

Field	Type	Label	Description
`document_id`	int64

services.documents.ListApprovalPoliciesResponse

Only one policy per document is supported currently.

Field	Type	Label	Description
`policy`	resources.documents.approval.ApprovalPolicy
`doc_meta`	resources.documents.DocumentMeta

services.documents.ListApprovalTasksInboxRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`statuses`	resources.documents.approval.ApprovalTaskStatus	repeated
`only_drafts`	bool	optional	Controls inclusion of drafts in the result: - unset/null: include all documents (drafts and non-drafts) - false: only non-draft documents - true: only draft documents
`not_already_acted`	bool	optional

services.documents.ListApprovalTasksInboxResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`tasks`	resources.documents.approval.ApprovalTask	repeated

services.documents.ListApprovalTasksRequest

Field	Type	Label	Description
`document_id`	int64
`statuses`	resources.documents.approval.ApprovalTaskStatus	repeated

services.documents.ListApprovalTasksResponse

Field	Type	Label	Description
`tasks`	resources.documents.approval.ApprovalTask	repeated

services.documents.ListApprovalsRequest

List approvals (artifacts) for a policy/snapshot. If snapshot_date is unset, server defaults to policy.snapshot_date.

Field	Type	Label	Description
`document_id`	int64
`task_id`	int64	optional
`snapshot_date`	resources.timestamp.Timestamp	optional
`status`	resources.documents.approval.ApprovalStatus	optional	Optional filters
`user_id`	int32	optional	Filter by signer

services.documents.ListApprovalsResponse

Field	Type	Label	Description
`approvals`	resources.documents.approval.Approval	repeated

services.documents.RecomputeApprovalPolicyCountersRequest

Field	Type	Label	Description
`document_id`	int64

services.documents.RecomputeApprovalPolicyCountersResponse

Field	Type	Label	Description
`policy`	resources.documents.approval.ApprovalPolicy

services.documents.ReopenApprovalTaskRequest

Field	Type	Label	Description
`task_id`	int64
`comment`	string

services.documents.ReopenApprovalTaskResponse

Field	Type	Label	Description
`task`	resources.documents.approval.ApprovalTask
`policy`	resources.documents.approval.ApprovalPolicy

services.documents.RevokeApprovalRequest

Field	Type	Label	Description
`approval_id`	int64
`comment`	string

services.documents.RevokeApprovalResponse

Field	Type	Label	Description
`approval`	resources.documents.approval.Approval
`doc_meta`	resources.documents.DocumentMeta

services.documents.UpsertApprovalPolicyRequest

Field	Type	Label	Description
`policy`	resources.documents.approval.ApprovalPolicy

services.documents.UpsertApprovalPolicyResponse

Field	Type	Label	Description
`policy`	resources.documents.approval.ApprovalPolicy
`doc_meta`	resources.documents.DocumentMeta

services.documents.UpsertApprovalTasksRequest

Upsert = insert missing PENDING tasks/slots; will NOT delete existing tasks. Identity rules (server-side): - USER task: unique by (document_id, snapshot_date, assignee_kind=USER, user_id) - JOB task: unique by (document_id, snapshot_date, assignee_kind=JOB, job, minimum_grade, slot_no) For JOB seeds with slots=N, the server ensures there are at least N PENDING slots (slot_no 1..N).

Field	Type	Label	Description
`document_id`	int64
`snapshot_date`	resources.timestamp.Timestamp	optional	If empty, use policy.snapshot_date
`seeds`	ApprovalTaskSeed	repeated

services.documents.UpsertApprovalTasksResponse

Field	Type	Description
`tasks_created`	int32	Number of new task rows inserted
`tasks_ensured`	int32	Number of requested targets already satisfied (no-op)
`policy`	resources.documents.approval.ApprovalPolicy	Echo (optional convenience)

services.documents.ApprovalService

Method Name	Request Type	Response Type	Description
`ListApprovalTasksInbox`	ListApprovalTasksInboxRequest	ListApprovalTasksInboxResponse	Inbox (for tasks assigned to user)
`ListApprovalPolicies`	ListApprovalPoliciesRequest	ListApprovalPoliciesResponse	Policies
`UpsertApprovalPolicy`	UpsertApprovalPolicyRequest	UpsertApprovalPolicyResponse
`ListApprovalTasks`	ListApprovalTasksRequest	ListApprovalTasksResponse	Tasks
`UpsertApprovalTasks`	UpsertApprovalTasksRequest	UpsertApprovalTasksResponse
`DeleteApprovalTasks`	DeleteApprovalTasksRequest	DeleteApprovalTasksResponse
`ListApprovals`	ListApprovalsRequest	ListApprovalsResponse	Approval
`RevokeApproval`	RevokeApprovalRequest	RevokeApprovalResponse
`DecideApproval`	DecideApprovalRequest	DecideApprovalResponse
`ReopenApprovalTask`	ReopenApprovalTaskRequest	ReopenApprovalTaskResponse
`RecomputeApprovalPolicyCounters`	RecomputeApprovalPolicyCountersRequest	RecomputeApprovalPolicyCountersResponse	Helpers

services/documents/categories.proto

services.documents.CreateOrUpdateCategoryRequest

Field	Type	Label	Description
`category`	resources.documents.category.Category

services.documents.CreateOrUpdateCategoryResponse

Field	Type	Label	Description
`category`	resources.documents.category.Category

services.documents.DeleteCategoryRequest

Field	Type	Label	Description
`id`	int64

services.documents.DeleteCategoryResponse

services.documents.ListCategoriesRequest

services.documents.ListCategoriesResponse

Field	Type	Label	Description
`categories`	resources.documents.category.Category	repeated

services.documents.CategoriesService

Method Name	Request Type	Response Type
`ListCategories`	ListCategoriesRequest	ListCategoriesResponse
`CreateOrUpdateCategory`	CreateOrUpdateCategoryRequest	CreateOrUpdateCategoryResponse
`DeleteCategory`	DeleteCategoryRequest	DeleteCategoryResponse

services/documents/collab.proto

services.documents.CollabService

Method Name	Request Type	Response Type	Description
`JoinRoom`	.resources.collab.ClientPacket stream	.resources.collab.ServerPacket stream	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME

services/documents/comments.proto

services.documents.DeleteCommentRequest

Field	Type	Label	Description
`comment_id`	int64

services.documents.DeleteCommentResponse

services.documents.EditCommentRequest

Field	Type	Label	Description
`comment`	resources.documents.comment.Comment

services.documents.EditCommentResponse

Field	Type	Label	Description
`comment`	resources.documents.comment.Comment

services.documents.GetCommentsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`document_id`	int64

services.documents.GetCommentsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`comments`	resources.documents.comment.Comment	repeated

services.documents.PostCommentRequest

Field	Type	Label	Description
`comment`	resources.documents.comment.Comment

services.documents.PostCommentResponse

Field	Type	Label	Description
`comment`	resources.documents.comment.Comment

services.documents.CommentsService

Method Name	Request Type	Response Type
`GetComments`	GetCommentsRequest	GetCommentsResponse
`PostComment`	PostCommentRequest	PostCommentResponse
`EditComment`	EditCommentRequest	EditCommentResponse
`DeleteComment`	DeleteCommentRequest	DeleteCommentResponse

services/documents/documents.proto

services.documents.AddDocumentReferenceRequest

Field	Type	Label	Description
`reference`	resources.documents.references.DocumentReference

services.documents.AddDocumentReferenceResponse

Field	Type	Label	Description
`id`	int64

services.documents.AddDocumentRelationRequest

Field	Type	Label	Description
`relation`	resources.documents.relations.DocumentRelation

services.documents.AddDocumentRelationResponse

Field	Type	Label	Description
`id`	int64

services.documents.ChangeDocumentOwnerRequest

Field	Type	Label	Description
`document_id`	int64
`new_user_id`	int32	optional

services.documents.ChangeDocumentOwnerResponse

services.documents.CreateDocumentReqRequest

Field	Type	Label
`document_id`	int64
`request_type`	resources.documents.activity.DocActivityType
`reason`	string	optional
`data`	resources.documents.activity.DocActivityData	optional

services.documents.CreateDocumentReqResponse

Field	Type	Label	Description
`request`	resources.documents.requests.DocRequest

services.documents.CreateDocumentRequest

Field	Type	Label
`content_type`	resources.common.content.ContentType
`template_id`	int64	optional
`template_data`	resources.documents.templates.TemplateData	optional

services.documents.CreateDocumentResponse

Field	Type	Label	Description
`id`	int64

services.documents.DeleteDocumentReqRequest

Field	Type	Label	Description
`request_id`	int64

services.documents.DeleteDocumentReqResponse

services.documents.DeleteDocumentRequest

Field	Type	Label	Description
`document_id`	int64
`reason`	string	optional

services.documents.DeleteDocumentResponse

services.documents.GetDocumentAccessRequest

Field	Type	Label	Description
`document_id`	int64

services.documents.GetDocumentAccessResponse

Field	Type	Label	Description
`access`	resources.access.Access

services.documents.GetDocumentReferencesRequest

Field	Type	Label	Description
`document_id`	int64

services.documents.GetDocumentReferencesResponse

Field	Type	Label	Description
`references`	resources.documents.references.DocumentReference	repeated

services.documents.GetDocumentRelationsRequest

Field	Type	Label	Description
`document_id`	int64

services.documents.GetDocumentRelationsResponse

Field	Type	Label	Description
`relations`	resources.documents.relations.DocumentRelation	repeated

services.documents.GetDocumentRequest

Field	Type	Label	Description
`document_id`	int64
`info_only`	bool	optional

services.documents.GetDocumentResponse

Field	Type	Label	Description
`document`	resources.documents.Document
`access`	resources.access.Access

services.documents.ListDocumentActivityRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`document_id`	int64
`activity_types`	resources.documents.activity.DocActivityType	repeated	Search params

services.documents.ListDocumentActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.documents.activity.DocActivity	repeated

services.documents.ListDocumentPinsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`personal`	bool	optional	Search params If true, only personal pins are returned

services.documents.ListDocumentPinsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`documents`	resources.documents.DocumentShort	repeated

services.documents.ListDocumentReqsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`document_id`	int64

services.documents.ListDocumentReqsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`requests`	resources.documents.requests.DocRequest	repeated

services.documents.ListDocumentsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`search`	string	optional	Search params
`category_ids`	int64	repeated
`creator_ids`	int32	repeated
`from`	resources.timestamp.Timestamp	optional
`to`	resources.timestamp.Timestamp	optional
`closed`	bool	optional
`document_ids`	int64	repeated
`only_drafts`	bool	optional	Controls inclusion of drafts in the result: - unset/null: include all documents (drafts and non-drafts) - false: only non-draft documents - true: only draft documents

services.documents.ListDocumentsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`documents`	resources.documents.DocumentShort	repeated

services.documents.ListUserDocumentsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`user_id`	int32
`relations`	resources.documents.relations.DocRelation	repeated
`closed`	bool	optional
`include_created`	bool	optional	Include the document relations created by the given user.

services.documents.ListUserDocumentsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`relations`	resources.documents.relations.DocumentRelation	repeated

services.documents.RemoveDocumentReferenceRequest

Field	Type	Label	Description
`id`	int64

services.documents.RemoveDocumentReferenceResponse

services.documents.RemoveDocumentRelationRequest

Field	Type	Label	Description
`id`	int64

services.documents.RemoveDocumentRelationResponse

services.documents.SetDocumentAccessRequest

Field	Type	Label	Description
`document_id`	int64
`access`	resources.access.Access

services.documents.SetDocumentAccessResponse

services.documents.SetDocumentReminderRequest

Field	Type	Label
`document_id`	int64
`reminder_time`	resources.timestamp.Timestamp	optional
`message`	string	optional
`max_reminder_count`	int32

services.documents.SetDocumentReminderResponse

services.documents.ToggleDocumentPinRequest

Field	Type	Label	Description
`document_id`	int64
`state`	bool
`personal`	bool	optional	If true, the pin is personal and not shared with other job members

services.documents.ToggleDocumentPinResponse

Field	Type	Label	Description
`pin`	resources.documents.pins.DocumentPin	optional

services.documents.ToggleDocumentRequest

Field	Type	Label	Description
`document_id`	int64
`closed`	bool

services.documents.ToggleDocumentResponse

services.documents.UpdateDocumentReqRequest

Field	Type	Label
`document_id`	int64
`request_id`	int64
`reason`	string	optional
`data`	resources.documents.activity.DocActivityData	optional
`accepted`	bool

services.documents.UpdateDocumentReqResponse

Field	Type	Label	Description
`request`	resources.documents.requests.DocRequest

services.documents.UpdateDocumentRequest

Field	Type	Label
`document_id`	int64
`category_id`	int64	optional
`title`	string
`content`	resources.common.content.Content
`content_type`	resources.common.content.ContentType
`data`	resources.documents.data.DocumentData	optional
`meta`	resources.documents.DocumentMeta
`access`	resources.access.Access	optional
`files`	resources.file.File	repeated

services.documents.UpdateDocumentResponse

Field	Type	Label	Description
`document`	resources.documents.Document

services.documents.DocumentsService

Method Name	Request Type	Response Type
`ListDocuments`	ListDocumentsRequest	ListDocumentsResponse
`GetDocument`	GetDocumentRequest	GetDocumentResponse
`CreateDocument`	CreateDocumentRequest	CreateDocumentResponse
`UpdateDocument`	UpdateDocumentRequest	UpdateDocumentResponse
`DeleteDocument`	DeleteDocumentRequest	DeleteDocumentResponse
`ToggleDocument`	ToggleDocumentRequest	ToggleDocumentResponse
`ChangeDocumentOwner`	ChangeDocumentOwnerRequest	ChangeDocumentOwnerResponse
`GetDocumentReferences`	GetDocumentReferencesRequest	GetDocumentReferencesResponse
`GetDocumentRelations`	GetDocumentRelationsRequest	GetDocumentRelationsResponse
`AddDocumentReference`	AddDocumentReferenceRequest	AddDocumentReferenceResponse
`RemoveDocumentReference`	RemoveDocumentReferenceRequest	RemoveDocumentReferenceResponse
`AddDocumentRelation`	AddDocumentRelationRequest	AddDocumentRelationResponse
`RemoveDocumentRelation`	RemoveDocumentRelationRequest	RemoveDocumentRelationResponse
`GetDocumentAccess`	GetDocumentAccessRequest	GetDocumentAccessResponse
`SetDocumentAccess`	SetDocumentAccessRequest	SetDocumentAccessResponse
`ListDocumentActivity`	ListDocumentActivityRequest	ListDocumentActivityResponse
`ListDocumentReqs`	ListDocumentReqsRequest	ListDocumentReqsResponse
`CreateDocumentReq`	CreateDocumentReqRequest	CreateDocumentReqResponse
`UpdateDocumentReq`	UpdateDocumentReqRequest	UpdateDocumentReqResponse
`DeleteDocumentReq`	DeleteDocumentReqRequest	DeleteDocumentReqResponse
`ListUserDocuments`	ListUserDocumentsRequest	ListUserDocumentsResponse
`ListDocumentPins`	ListDocumentPinsRequest	ListDocumentPinsResponse
`ToggleDocumentPin`	ToggleDocumentPinRequest	ToggleDocumentPinResponse
`SetDocumentReminder`	SetDocumentReminderRequest	SetDocumentReminderResponse
`UploadFile`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse

services/documents/forms.proto

services.documents.GetFormRequest

Field	Type	Label	Description
`form_id`	int64

services.documents.GetFormResponse

Field	Type	Label	Description
`form`	resources.documents.forms.Form

services.documents.ListFormsRequest

services.documents.ListFormsResponse

Field	Type	Label	Description
`forms`	resources.documents.forms.Form	repeated

services.documents.FormsService

Method Name	Request Type	Response Type	Description
`GetForm`	GetFormRequest	GetFormResponse
`ListForms`	ListFormsRequest	ListFormsResponse

services/documents/stamps.proto

services.documents.DeleteStampRequest

Field	Type	Label	Description
`stamp_id`	int64

services.documents.DeleteStampResponse

services.documents.GetStampRequest

Field	Type	Label	Description
`id`	int64

services.documents.GetStampResponse

Field	Type	Label	Description
`stamp`	resources.documents.stamps.Stamp

services.documents.ListUsableStampsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`document_id`	int64	optional	If set, only stamps usable for signing this document are returned

services.documents.ListUsableStampsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`stamps`	resources.documents.stamps.Stamp	repeated

services.documents.UpsertStampRequest

Field	Type	Label	Description
`stamp`	resources.documents.stamps.Stamp

services.documents.UpsertStampResponse

Field	Type	Label	Description
`stamp`	resources.documents.stamps.Stamp

services.documents.StampsService

Method Name	Request Type	Response Type
`ListUsableStamps`	ListUsableStampsRequest	ListUsableStampsResponse
`GetStamp`	GetStampRequest	GetStampResponse
`UpsertStamp`	UpsertStampRequest	UpsertStampResponse
`DeleteStamp`	DeleteStampRequest	DeleteStampResponse

services/documents/stats.proto

services.documents.GetStatsRequest

Field	Type	Label
`start`	resources.timestamp.Timestamp
`end`	resources.timestamp.Timestamp
`period`	resources.stats.StatsPeriod
`category`	resources.stats.StatsCategory
`jobs`	string	repeated

services.documents.GetStatsResponse

Field	Type	Label
`top_laws`	resources.stats.KeyValue	repeated
`fines_over_time`	resources.stats.DailyValue	repeated
`documents_by_category`	resources.stats.CategoryValue	repeated
`period_values`	resources.stats.DailyValue	repeated
`period_series_values`	resources.stats.PeriodSeriesValue	repeated
`total_value`	int64
`average_value`	double

services.documents.StatsService

Method Name	Request Type	Response Type	Description
`GetStats`	GetStatsRequest	GetStatsResponse

services/documents/templates.proto

services.documents.CreateTemplateRequest

Field	Type	Label	Description
`template`	resources.documents.templates.Template

services.documents.CreateTemplateResponse

Field	Type	Label	Description
`id`	int64

services.documents.DeleteTemplateRequest

Field	Type	Label	Description
`id`	int64

services.documents.DeleteTemplateResponse

services.documents.GetTemplateRequest

Field	Type	Label
`template_id`	int64
`data`	resources.documents.templates.TemplateData	optional
`render`	bool	optional

services.documents.GetTemplateResponse

Field	Type	Label	Description
`template`	resources.documents.templates.Template
`rendered`	bool

services.documents.ListTemplatesRequest

services.documents.ListTemplatesResponse

Field	Type	Label	Description
`templates`	resources.documents.templates.TemplateShort	repeated

services.documents.MoveTemplateRequest

Field	Type	Label
`template_id`	int64
`before_id`	int64	optional
`after_id`	int64	optional

services.documents.MoveTemplateResponse

services.documents.UpdateTemplateRequest

Field	Type	Label	Description
`template`	resources.documents.templates.Template

services.documents.UpdateTemplateResponse

Field	Type	Label	Description
`template`	resources.documents.templates.Template

services.documents.TemplatesService

Method Name	Request Type	Response Type
`ListTemplates`	ListTemplatesRequest	ListTemplatesResponse
`GetTemplate`	GetTemplateRequest	GetTemplateResponse
`CreateTemplate`	CreateTemplateRequest	CreateTemplateResponse
`UpdateTemplate`	UpdateTemplateRequest	UpdateTemplateResponse
`DeleteTemplate`	DeleteTemplateRequest	DeleteTemplateResponse
`MoveTemplate`	MoveTemplateRequest	MoveTemplateResponse

services/filestore/filestore.proto

services.filestore.DeleteFileByPathRequest

Field	Type	Label	Description
`path`	string

services.filestore.DeleteFileByPathResponse

services.filestore.ListFilesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`path`	string	optional

services.filestore.ListFilesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`files`	resources.file.File	repeated

services.filestore.FilestoreService

Method Name	Request Type	Response Type	Description
`Upload`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
`ListFiles`	ListFilesRequest	ListFilesResponse
`DeleteFile`	.resources.file.DeleteFileRequest	.resources.file.DeleteFileResponse
`DeleteFileByPath`	DeleteFileByPathRequest	DeleteFileByPathResponse

services/jobs/colleagues.proto

services.jobs.CreateOrUpdateLabelRequest

Field	Type	Label	Description
`label`	resources.jobs.labels.Label

services.jobs.CreateOrUpdateLabelResponse

Field	Type	Label	Description
`label`	resources.jobs.labels.Label

services.jobs.DeleteLabelRequest

Field	Type	Label	Description
`id`	int64

services.jobs.DeleteLabelResponse

services.jobs.GetColleagueLabelsRequest

Field	Type	Label	Description
`search`	string	optional

services.jobs.GetColleagueLabelsResponse

Field	Type	Label	Description
`labels`	resources.jobs.labels.Label	repeated

services.jobs.GetColleagueLabelsStatsRequest

Field	Type	Label	Description
`label_ids`	int64	repeated

services.jobs.GetColleagueLabelsStatsResponse

Field	Type	Label	Description
`count`	resources.jobs.labels.LabelCount	repeated

services.jobs.GetColleagueRequest

Field	Type	Label	Description
`user_id`	int32
`info_only`	bool	optional

services.jobs.GetColleagueResponse

Field	Type	Label	Description
`colleague`	resources.jobs.colleagues.Colleague

services.jobs.GetSelfRequest

services.jobs.GetSelfResponse

Field	Type	Label	Description
`colleague`	resources.jobs.colleagues.Colleague

services.jobs.ListColleagueActivityRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`users`	resources.jobs.UserSelector	optional	Search params
`activity_types`	resources.jobs.colleagues.activity.ColleagueActivityType	repeated

services.jobs.ListColleagueActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.jobs.colleagues.activity.ColleagueActivity	repeated

services.jobs.ListColleaguesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`search`	string		Search params
`users`	resources.jobs.UserSelector	optional
`user_only`	bool	optional
`absent`	bool	optional
`label_ids`	int64	repeated
`name_prefix`	string	optional
`name_suffix`	string	optional

services.jobs.ListColleaguesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`colleagues`	resources.jobs.colleagues.Colleague	repeated

services.jobs.ReorderLabelsRequest

Field	Type	Label	Description
`label_ids`	int64	repeated

services.jobs.ReorderLabelsResponse

services.jobs.SetColleaguePropsRequest

Field	Type	Label	Description
`props`	resources.jobs.colleagues.ColleagueProps
`reason`	string

services.jobs.SetColleaguePropsResponse

Field	Type	Label	Description
`props`	resources.jobs.colleagues.ColleagueProps

services.jobs.ColleaguesService

Method Name	Request Type	Response Type
`ListColleagues`	ListColleaguesRequest	ListColleaguesResponse
`GetSelf`	GetSelfRequest	GetSelfResponse
`GetColleague`	GetColleagueRequest	GetColleagueResponse
`ListColleagueActivity`	ListColleagueActivityRequest	ListColleagueActivityResponse
`SetColleagueProps`	SetColleaguePropsRequest	SetColleaguePropsResponse
`GetColleagueLabels`	GetColleagueLabelsRequest	GetColleagueLabelsResponse
`CreateOrUpdateLabel`	CreateOrUpdateLabelRequest	CreateOrUpdateLabelResponse
`DeleteLabel`	DeleteLabelRequest	DeleteLabelResponse
`ReorderLabels`	ReorderLabelsRequest	ReorderLabelsResponse
`GetColleagueLabelsStats`	GetColleagueLabelsStatsRequest	GetColleagueLabelsStatsResponse

services/jobs/conduct.proto

services.jobs.CreateConductEntryRequest

Field	Type	Label	Description
`entry`	resources.jobs.conduct.ConductEntry

services.jobs.CreateConductEntryResponse

Field	Type	Label	Description
`entry`	resources.jobs.conduct.ConductEntry

services.jobs.DeleteConductEntryRequest

Field	Type	Label	Description
`id`	int64

services.jobs.DeleteConductEntryResponse

services.jobs.GetConductEntryRequest

Field	Type	Label	Description
`id`	int64

services.jobs.GetConductEntryResponse

Field	Type	Label	Description
`entry`	resources.jobs.conduct.ConductEntry

services.jobs.ListConductEntriesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`types`	resources.jobs.conduct.ConductType	repeated	Search params
`show_expired`	bool	optional
`show_drafts`	bool	optional
`users`	resources.jobs.UserSelector	optional
`ids`	int64	repeated
`show_deleted`	bool	optional

services.jobs.ListConductEntriesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`entries`	resources.jobs.conduct.ConductEntry	repeated

services.jobs.UpdateConductEntryRequest

Field	Type	Label	Description
`entry`	resources.jobs.conduct.ConductEntry

services.jobs.UpdateConductEntryResponse

Field	Type	Label	Description
`entry`	resources.jobs.conduct.ConductEntry

services.jobs.ConductService

Method Name	Request Type	Response Type
`ListConductEntries`	ListConductEntriesRequest	ListConductEntriesResponse
`GetConductEntry`	GetConductEntryRequest	GetConductEntryResponse
`CreateConductEntry`	CreateConductEntryRequest	CreateConductEntryResponse
`UpdateConductEntry`	UpdateConductEntryRequest	UpdateConductEntryResponse
`DeleteConductEntry`	DeleteConductEntryRequest	DeleteConductEntryResponse
`UploadFile`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse

services/jobs/groups.proto

services.jobs.AddGroupLeaderRequest

Field	Type	Label
`group_id`	int64
`user_id`	int32
`reason`	string	optional

services.jobs.AddGroupLeaderResponse

Field	Type	Label	Description
`leader`	resources.jobs.groups.GroupLeader
`group`	resources.jobs.groups.Group

services.jobs.AddGroupMemberRequest

Field	Type	Label
`group_id`	int64
`user_id`	int32
`reason`	string	optional

services.jobs.AddGroupMemberResponse

Field	Type	Label	Description
`member`	resources.jobs.groups.GroupManualMember
`group`	resources.jobs.groups.Group

services.jobs.ArchiveGroupRequest

Field	Type	Label	Description
`id`	int64
`reason`	string	optional

services.jobs.ArchiveGroupResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.CreateGroupRequest

Field	Type	Label
`job`	string
`name`	string
`description`	string	optional
`short_name`	string	optional
`color`	string	optional
`type`	resources.jobs.groups.GroupType	optional
`membership_mode`	resources.jobs.groups.GroupMembershipMode	optional
`sort_rank`	string	optional
`leader_user_ids`	int32	repeated
`manual_member_user_ids`	int32	repeated
`rules`	GroupRuleInput	repeated
`access`	resources.access.Access	optional

services.jobs.CreateGroupResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.CreateGroupRuleRequest

Field	Type	Label
`group_id`	int64
`rule`	GroupRuleInput
`reason`	string	optional

services.jobs.CreateGroupRuleResponse

Field	Type	Label	Description
`rule`	resources.jobs.groups.GroupRule
`group`	resources.jobs.groups.Group

services.jobs.DeleteGroupLogoRequest

Field	Type	Label	Description
`id`	int64

services.jobs.DeleteGroupLogoResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.DeleteGroupRuleRequest

Field	Type	Label
`group_id`	int64
`rule_id`	int64
`reason`	string	optional

services.jobs.DeleteGroupRuleResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.ExcludeGroupMemberRequest

Field	Type	Label
`group_id`	int64
`user_id`	int32
`reason_type`	resources.jobs.groups.GroupExclusionReason
`reason`	string	optional

services.jobs.ExcludeGroupMemberResponse

Field	Type	Label	Description
`exclusion`	resources.jobs.groups.GroupMemberExclusion
`group`	resources.jobs.groups.Group

services.jobs.GetGroupRequest

Field	Type	Label	Description
`id`	int64
`include_archived`	bool

services.jobs.GetGroupResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group
`access`	resources.access.Access	optional

services.jobs.GroupRuleInput

Field	Type	Label
`enabled`	bool	optional
`grade`	resources.jobs.groups.GroupGradeRule
`qualification`	resources.jobs.groups.GroupQualificationRule

services.jobs.ListGroupActivityRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest	optional
`sort`	resources.common.database.Sort	optional
`group_id`	int64
`types`	resources.jobs.groups.GroupActivityType	repeated
`user_id`	int32	optional
`from`	resources.timestamp.Timestamp	optional
`to`	resources.timestamp.Timestamp	optional

services.jobs.ListGroupActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse	optional
`activity`	resources.jobs.groups.GroupActivity	repeated

services.jobs.ListGroupLeadersRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`group_id`	int64
`search`	string	optional

services.jobs.ListGroupLeadersResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`leaders`	resources.jobs.groups.GroupLeader	repeated

services.jobs.ListGroupManualMembersRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`group_id`	int64
`search`	string	optional

services.jobs.ListGroupManualMembersResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`manual_members`	resources.jobs.groups.GroupManualMember	repeated

services.jobs.ListGroupMemberExclusionsRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`group_id`	int64
`search`	string	optional

services.jobs.ListGroupMemberExclusionsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`exclusions`	resources.jobs.groups.GroupMemberExclusion	repeated

services.jobs.ListGroupMembersRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`group_id`	int64
`search`	string	optional
`include_excluded`	bool
`include_leaders`	bool
`include_reasons`	bool
`sources`	resources.jobs.groups.GroupMemberSource	repeated

services.jobs.ListGroupMembersResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`members`	resources.jobs.groups.GroupResolvedMember	repeated

services.jobs.ListGroupRulesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`group_id`	int64

services.jobs.ListGroupRulesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`rules`	resources.jobs.groups.GroupRule	repeated

services.jobs.ListGroupsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`states`	resources.jobs.groups.GroupState	repeated	Search params
`search`	string	optional
`include_counts`	bool
`include_inactive`	bool
`include_archived`	bool
`group_ids`	int32	repeated
`kind`	resources.jobs.groups.GroupType	optional

services.jobs.ListGroupsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`groups`	resources.jobs.groups.Group	repeated

services.jobs.RemoveGroupLeaderRequest

Field	Type	Label
`group_id`	int64
`user_id`	int32
`reason`	string	optional

services.jobs.RemoveGroupLeaderResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.RemoveGroupMemberExclusionRequest

Field	Type	Label
`group_id`	int64
`user_id`	int32
`reason`	string	optional

services.jobs.RemoveGroupMemberExclusionResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.RemoveGroupMemberRequest

Field	Type	Label
`group_id`	int64
`user_id`	int32
`reason`	string	optional

services.jobs.RemoveGroupMemberResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.RestoreGroupRequest

Field	Type	Label	Description
`id`	int64
`reason`	string	optional

services.jobs.RestoreGroupResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.UpdateGroupRequest

Field	Type	Label
`id`	int64
`name`	string	optional
`description`	string	optional
`short_name`	string	optional
`color`	string	optional
`state`	resources.jobs.groups.GroupState	optional
`type`	resources.jobs.groups.GroupType	optional
`membership_mode`	resources.jobs.groups.GroupMembershipMode	optional
`sort_rank`	string	optional
`access`	resources.access.Access	optional

services.jobs.UpdateGroupResponse

Field	Type	Label	Description
`group`	resources.jobs.groups.Group

services.jobs.UpdateGroupRuleRequest

Field	Type	Label
`group_id`	int64
`rule_id`	int64
`rule`	GroupRuleInput
`reason`	string	optional

services.jobs.UpdateGroupRuleResponse

Field	Type	Label	Description
`rule`	resources.jobs.groups.GroupRule
`group`	resources.jobs.groups.Group

services.jobs.GroupsService

Method Name	Request Type	Response Type	Description
`ListGroups`	ListGroupsRequest	ListGroupsResponse
`GetGroup`	GetGroupRequest	GetGroupResponse
`CreateGroup`	CreateGroupRequest	CreateGroupResponse
`UpdateGroup`	UpdateGroupRequest	UpdateGroupResponse
`ArchiveGroup`	ArchiveGroupRequest	ArchiveGroupResponse
`RestoreGroup`	RestoreGroupRequest	RestoreGroupResponse
`UploadGroupLogo`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
`DeleteGroupLogo`	DeleteGroupLogoRequest	DeleteGroupLogoResponse
`ListGroupMembers`	ListGroupMembersRequest	ListGroupMembersResponse
`ListGroupManualMembers`	ListGroupManualMembersRequest	ListGroupManualMembersResponse
`ListGroupMemberExclusions`	ListGroupMemberExclusionsRequest	ListGroupMemberExclusionsResponse
`ListGroupLeaders`	ListGroupLeadersRequest	ListGroupLeadersResponse
`AddGroupMember`	AddGroupMemberRequest	AddGroupMemberResponse
`RemoveGroupMember`	RemoveGroupMemberRequest	RemoveGroupMemberResponse
`ExcludeGroupMember`	ExcludeGroupMemberRequest	ExcludeGroupMemberResponse
`RemoveGroupMemberExclusion`	RemoveGroupMemberExclusionRequest	RemoveGroupMemberExclusionResponse
`AddGroupLeader`	AddGroupLeaderRequest	AddGroupLeaderResponse
`RemoveGroupLeader`	RemoveGroupLeaderRequest	RemoveGroupLeaderResponse
`CreateGroupRule`	CreateGroupRuleRequest	CreateGroupRuleResponse
`ListGroupRules`	ListGroupRulesRequest	ListGroupRulesResponse
`UpdateGroupRule`	UpdateGroupRuleRequest	UpdateGroupRuleResponse
`DeleteGroupRule`	DeleteGroupRuleRequest	DeleteGroupRuleResponse
`ListGroupActivity`	ListGroupActivityRequest	ListGroupActivityResponse

services/jobs/jobs.proto

services.jobs.GetMOTDRequest

services.jobs.GetMOTDResponse

Field	Type	Label	Description
`motd`	string

services.jobs.SetMOTDRequest

Field	Type	Label	Description
`motd`	string

services.jobs.SetMOTDResponse

Field	Type	Label	Description
`motd`	string

services.jobs.JobsService

Method Name	Request Type	Response Type	Description
`GetMOTD`	GetMOTDRequest	GetMOTDResponse
`SetMOTD`	SetMOTDRequest	SetMOTDResponse

services/jobs/stats.proto

services.jobs.GetStatsRequest

Field	Type	Label	Description
`start`	resources.timestamp.Timestamp
`end`	resources.timestamp.Timestamp
`period`	resources.stats.StatsPeriod
`category`	resources.stats.StatsCategory

services.jobs.GetStatsResponse

Field	Type	Label
`period_values`	resources.stats.DailyValue	repeated
`period_series_values`	resources.stats.PeriodSeriesValue	repeated
`total_value`	int64
`average_value`	double

services.jobs.StatsService

Method Name	Request Type	Response Type	Description
`GetStats`	GetStatsRequest	GetStatsResponse

services/jobs/timeclock.proto

services.jobs.GetTimeclockStatsRequest

Field	Type	Label	Description
`users`	resources.jobs.UserSelector	optional

services.jobs.GetTimeclockStatsResponse

Field	Type	Label	Description
`stats`	resources.jobs.timeclock.TimeclockStats
`weekly`	resources.jobs.timeclock.TimeclockWeeklyStats	repeated

services.jobs.ListInactiveEmployeesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`days`	int32		Search params
`users`	resources.jobs.UserSelector	optional

services.jobs.ListInactiveEmployeesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`colleagues`	resources.jobs.colleagues.Colleague	repeated

services.jobs.ListTimeclockRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`user_mode`	resources.jobs.timeclock.TimeclockViewMode		Search params
`mode`	resources.jobs.timeclock.TimeclockMode
`date`	resources.common.database.DateRange	optional
`per_day`	bool
`users`	resources.jobs.UserSelector	optional

services.jobs.ListTimeclockResponse

Field	Type	Label
`pagination`	resources.common.database.PaginationResponse
`stats`	resources.jobs.timeclock.TimeclockStats
`stats_weekly`	resources.jobs.timeclock.TimeclockWeeklyStats	repeated
`daily`	TimeclockDay
`weekly`	TimeclockWeekly
`range`	TimeclockRange

services.jobs.TimeclockDay

Field	Type	Label
`date`	resources.timestamp.Timestamp
`entries`	resources.jobs.timeclock.TimeclockEntry	repeated
`sum`	int64

services.jobs.TimeclockRange

Field	Type	Label
`date`	resources.timestamp.Timestamp
`entries`	resources.jobs.timeclock.TimeclockEntry	repeated
`sum`	int64

services.jobs.TimeclockWeekly

Field	Type	Label
`date`	resources.timestamp.Timestamp
`entries`	resources.jobs.timeclock.TimeclockEntry	repeated
`sum`	int64

services.jobs.TimeclockService

Method Name	Request Type	Response Type
`ListTimeclock`	ListTimeclockRequest	ListTimeclockResponse
`GetTimeclockStats`	GetTimeclockStatsRequest	GetTimeclockStatsResponse
`ListInactiveEmployees`	ListInactiveEmployeesRequest	ListInactiveEmployeesResponse

services/livemap/livemap.proto

services.livemap.CreateOrUpdateMarkerRequest

Field	Type	Label	Description
`marker`	resources.livemap.markers.MarkerMarker

services.livemap.CreateOrUpdateMarkerResponse

Field	Type	Label	Description
`marker`	resources.livemap.markers.MarkerMarker

services.livemap.DeleteMarkerRequest

Field	Type	Label	Description
`id`	int64

services.livemap.DeleteMarkerResponse

services.livemap.JobsList

Field	Type	Label	Description
`users`	resources.jobs.Job	repeated
`markers`	resources.jobs.Job	repeated

services.livemap.MarkerMarkersUpdates

Field	Type	Label
`updated`	resources.livemap.markers.MarkerMarker	repeated
`deleted`	int64	repeated
`part`	int32
`partial`	bool

services.livemap.Snapshot

A roll-up of the entire USERLOC bucket. Published every N seconds on $KV.user_locations._snapshot with the headers: Nats-Rollup: all KV-Operation: ROLLUP

Field	Type	Label	Description
`markers`	resources.livemap.markers.UserMarker	repeated	All currently-known user markers, already filtered for obsolete PURGE/DELETE events.

services.livemap.StreamRequest

services.livemap.StreamResponse

Field	Type	Label
`user_on_duty`	bool	optional
`jobs`	JobsList
`markers`	MarkerMarkersUpdates
`snapshot`	Snapshot
`user_updates`	UserUpdates
`user_deletes`	UserDeletes

services.livemap.UserDelete

Field	Type	Label	Description
`id`	int32		The user ID of an user marker that was deleted.
`job`	string		The job of the user that was deleted.

services.livemap.UserDeletes

Field	Type	Label	Description
`deletes`	UserDelete	repeated

services.livemap.UserUpdates

Field	Type	Label	Description
`updates`	resources.livemap.markers.UserMarker	repeated

services.livemap.LivemapService

Method Name	Request Type	Response Type	Description
`Stream`	StreamRequest	StreamResponse stream
`CreateOrUpdateMarker`	CreateOrUpdateMarkerRequest	CreateOrUpdateMarkerResponse
`DeleteMarker`	DeleteMarkerRequest	DeleteMarkerResponse	Deletes or restores a marker. Private markers use the DeleteMarker Access attribute in the usual creator job/rank scope: Own allows the creator, Lower_Rank allows higher ranks, Same_Rank allows same-or-higher ranks, and Any allows any member in the creator's job. Public markers have stricter delete access because they can be visible across jobs: job admins can delete them; the marker creator can delete them only when Access includes Own; otherwise, only members of the marker's owning job with Access=Any can delete them.

services/mailer/mailer.proto

services.mailer.CreateOrUpdateEmailRequest

Field	Type	Label	Description
`email`	resources.mailer.emails.Email

services.mailer.CreateOrUpdateEmailResponse

Field	Type	Label	Description
`email`	resources.mailer.emails.Email

services.mailer.DeleteEmailRequest

Field	Type	Label	Description
`id`	int64

services.mailer.DeleteEmailResponse

services.mailer.GetEmailProposalsRequest

Field	Type	Label
`input`	string
`job`	bool	optional
`user_id`	int32	optional

services.mailer.GetEmailProposalsResponse

Field	Type	Label	Description
`emails`	string	repeated
`domains`	string	repeated

services.mailer.GetEmailRequest

Field	Type	Label	Description
`id`	int64

services.mailer.GetEmailResponse

Field	Type	Label	Description
`email`	resources.mailer.emails.Email

services.mailer.ListEmailsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`all`	bool	optional	Search params

services.mailer.ListEmailsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`emails`	resources.mailer.emails.Email	repeated

services.mailer.MailerService

Method Name	Request Type	Response Type
`ListEmails`	ListEmailsRequest	ListEmailsResponse
`GetEmail`	GetEmailRequest	GetEmailResponse
`CreateOrUpdateEmail`	CreateOrUpdateEmailRequest	CreateOrUpdateEmailResponse
`DeleteEmail`	DeleteEmailRequest	DeleteEmailResponse
`GetEmailProposals`	GetEmailProposalsRequest	GetEmailProposalsResponse

services/mailer/settings.proto

services.mailer.CreateOrUpdateTemplateRequest

Field	Type	Label	Description
`template`	resources.mailer.templates.Template

services.mailer.CreateOrUpdateTemplateResponse

Field	Type	Label	Description
`template`	resources.mailer.templates.Template

services.mailer.DeleteTemplateRequest

Field	Type	Label	Description
`email_id`	int64
`id`	int64

services.mailer.DeleteTemplateResponse

services.mailer.GetEmailSettingsRequest

Field	Type	Label	Description
`email_id`	int64

services.mailer.GetEmailSettingsResponse

Field	Type	Label	Description
`settings`	resources.mailer.settings.EmailSettings

services.mailer.GetTemplateRequest

Field	Type	Label	Description
`email_id`	int64
`template_id`	int64

services.mailer.GetTemplateResponse

Field	Type	Label	Description
`template`	resources.mailer.templates.Template

services.mailer.ListTemplatesRequest

Field	Type	Label	Description
`email_id`	int64

services.mailer.ListTemplatesResponse

Field	Type	Label	Description
`templates`	resources.mailer.templates.Template	repeated

services.mailer.SetEmailSettingsRequest

Field	Type	Label	Description
`settings`	resources.mailer.settings.EmailSettings

services.mailer.SetEmailSettingsResponse

Field	Type	Label	Description
`settings`	resources.mailer.settings.EmailSettings

services.mailer.SettingsService

Method Name	Request Type	Response Type
`ListTemplates`	ListTemplatesRequest	ListTemplatesResponse
`GetTemplate`	GetTemplateRequest	GetTemplateResponse
`CreateOrUpdateTemplate`	CreateOrUpdateTemplateRequest	CreateOrUpdateTemplateResponse
`DeleteTemplate`	DeleteTemplateRequest	DeleteTemplateResponse
`GetEmailSettings`	GetEmailSettingsRequest	GetEmailSettingsResponse
`SetEmailSettings`	SetEmailSettingsRequest	SetEmailSettingsResponse

services/mailer/thread.proto

services.mailer.CreateThreadRequest

Field	Type	Label
`thread`	resources.mailer.threads.Thread
`message`	resources.mailer.messages.Message
`recipients`	string	repeated

services.mailer.CreateThreadResponse

Field	Type	Label	Description
`thread`	resources.mailer.threads.Thread

services.mailer.DeleteMessageRequest

Field	Type	Label	Description
`email_id`	int64
`thread_id`	int64
`message_id`	int64

services.mailer.DeleteMessageResponse

services.mailer.DeleteThreadRequest

Field	Type	Label	Description
`email_id`	int64
`thread_id`	int64

services.mailer.DeleteThreadResponse

services.mailer.GetThreadRequest

Field	Type	Label	Description
`email_id`	int64
`thread_id`	int64

services.mailer.GetThreadResponse

Field	Type	Label	Description
`thread`	resources.mailer.threads.Thread

services.mailer.GetThreadStateRequest

Field	Type	Label	Description
`email_id`	int64
`thread_id`	int64

services.mailer.GetThreadStateResponse

Field	Type	Label	Description
`state`	resources.mailer.threads.ThreadState

services.mailer.ListThreadMessagesRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`email_id`	int64
`thread_id`	int64
`after`	resources.timestamp.Timestamp	optional

services.mailer.ListThreadMessagesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`messages`	resources.mailer.messages.Message	repeated

services.mailer.ListThreadsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`email_ids`	int64	repeated	Search params
`unread`	bool	optional
`archived`	bool	optional

services.mailer.ListThreadsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`threads`	resources.mailer.threads.Thread	repeated

services.mailer.PostMessageRequest

Field	Type	Label	Description
`message`	resources.mailer.messages.Message
`recipients`	string	repeated

services.mailer.PostMessageResponse

Field	Type	Label	Description
`message`	resources.mailer.messages.Message

services.mailer.SearchThreadsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`search`	string		Search params

services.mailer.SearchThreadsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`messages`	resources.mailer.messages.Message	repeated

services.mailer.SetThreadStateRequest

Field	Type	Label	Description
`state`	resources.mailer.threads.ThreadState

services.mailer.SetThreadStateResponse

Field	Type	Label	Description
`state`	resources.mailer.threads.ThreadState

services.mailer.ThreadService

Method Name	Request Type	Response Type
`ListThreads`	ListThreadsRequest	ListThreadsResponse
`GetThread`	GetThreadRequest	GetThreadResponse
`CreateThread`	CreateThreadRequest	CreateThreadResponse
`DeleteThread`	DeleteThreadRequest	DeleteThreadResponse
`GetThreadState`	GetThreadStateRequest	GetThreadStateResponse
`SetThreadState`	SetThreadStateRequest	SetThreadStateResponse
`SearchThreads`	SearchThreadsRequest	SearchThreadsResponse
`ListThreadMessages`	ListThreadMessagesRequest	ListThreadMessagesResponse
`PostMessage`	PostMessageRequest	PostMessageResponse
`DeleteMessage`	DeleteMessageRequest	DeleteMessageResponse

services/notifications/notifications.proto

services.notifications.GetNotificationsRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`include_read`	bool	optional
`categories`	resources.notifications.NotificationCategory	repeated

services.notifications.GetNotificationsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`notifications`	resources.notifications.Notification	repeated

services.notifications.MarkNotificationsRequest

Field	Type	Label
`unread`	bool
`ids`	int64	repeated
`all`	bool	optional

services.notifications.MarkNotificationsResponse

Field	Type	Label	Description
`updated`	int64

services.notifications.StreamRequest

Field	Type	Label	Description
`clientview`	resources.notifications.clientview.ClientView

services.notifications.StreamResponse

Field	Type	Label
`notification_count`	int64
`restart`	bool	optional
`user_event`	resources.notifications.events.UserEvent
`job_event`	resources.notifications.events.JobEvent
`job_grade_event`	resources.notifications.events.JobGradeEvent
`system_event`	resources.notifications.events.SystemEvent
`mailer_event`	resources.mailer.events.MailerEvent
`object_event`	resources.notifications.clientview.ObjectEvent

services.notifications.NotificationsService

Method Name	Request Type	Response Type
`GetNotifications`	GetNotificationsRequest	GetNotificationsResponse
`MarkNotifications`	MarkNotificationsRequest	MarkNotificationsResponse
`Stream`	StreamRequest stream	StreamResponse stream

services/qualifications/exam.proto

services.qualifications.GetExamInfoRequest

Field	Type	Label	Description
`qualification_id`	int64

services.qualifications.GetExamInfoResponse

Field	Type	Label
`qualification`	resources.qualifications.QualificationShort
`question_count`	int64
`exam_user`	resources.qualifications.exam.ExamUser	optional

services.qualifications.GetUserExamRequest

Field	Type	Label	Description
`qualification_id`	int64
`user_id`	int32

services.qualifications.GetUserExamResponse

Field	Type	Label	Description
`exam`	resources.qualifications.exam.ExamQuestions
`exam_user`	resources.qualifications.exam.ExamUser
`responses`	resources.qualifications.exam.ExamResponses
`grading`	resources.qualifications.exam.ExamGrading

services.qualifications.SubmitExamRequest

Field	Type	Label	Description
`qualification_id`	int64
`responses`	resources.qualifications.exam.ExamResponses
`partial`	bool

services.qualifications.SubmitExamResponse

Field	Type	Label	Description
`duration`	google.protobuf.Duration

services.qualifications.TakeExamRequest

Field	Type	Label	Description
`qualification_id`	int64
`cancel`	bool	optional

services.qualifications.TakeExamResponse

Field	Type	Label	Description
`exam`	resources.qualifications.exam.ExamQuestions
`exam_user`	resources.qualifications.exam.ExamUser
`responses`	resources.qualifications.exam.ExamResponses
`times_up`	bool

services.qualifications.ExamService

Method Name	Request Type	Response Type
`GetExamInfo`	GetExamInfoRequest	GetExamInfoResponse
`TakeExam`	TakeExamRequest	TakeExamResponse
`SubmitExam`	SubmitExamRequest	SubmitExamResponse
`GetUserExam`	GetUserExamRequest	GetUserExamResponse

services/qualifications/qualifications.proto

services.qualifications.CreateOrUpdateQualificationRequestRequest

Field	Type	Label	Description
`request`	resources.qualifications.QualificationRequest

services.qualifications.CreateOrUpdateQualificationRequestResponse

Field	Type	Label	Description
`request`	resources.qualifications.QualificationRequest

services.qualifications.CreateOrUpdateQualificationResultRequest

Field	Type	Label	Description
`result`	resources.qualifications.QualificationResult
`grading`	resources.qualifications.exam.ExamGrading	optional

services.qualifications.CreateOrUpdateQualificationResultResponse

Field	Type	Label	Description
`result`	resources.qualifications.QualificationResult

services.qualifications.CreateQualificationRequest

Field	Type	Label	Description
`content_type`	resources.common.content.ContentType

services.qualifications.CreateQualificationResponse

Field	Type	Label	Description
`qualification_id`	int64

services.qualifications.DeleteQualificationReqRequest

Field	Type	Label	Description
`qualification_id`	int64
`user_id`	int32

services.qualifications.DeleteQualificationReqResponse

services.qualifications.DeleteQualificationRequest

Field	Type	Label	Description
`qualification_id`	int64

services.qualifications.DeleteQualificationResponse

services.qualifications.DeleteQualificationResultRequest

Field	Type	Label	Description
`result_id`	int64

services.qualifications.DeleteQualificationResultResponse

services.qualifications.GetQualificationAccessRequest

Field	Type	Label	Description
`qualification_id`	int64

services.qualifications.GetQualificationAccessResponse

Field	Type	Label	Description
`access`	resources.access.Access

services.qualifications.GetQualificationRequest

Field	Type	Label	Description
`qualification_id`	int64
`with_exam`	bool	optional

services.qualifications.GetQualificationResponse

Field	Type	Label	Description
`qualification`	resources.qualifications.Qualification

services.qualifications.ListQualificationRequestsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`qualification_id`	int64	optional	Search params
`status`	resources.qualifications.RequestStatus	repeated
`user_ids`	int32	repeated

services.qualifications.ListQualificationRequestsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`requests`	resources.qualifications.QualificationRequest	repeated

services.qualifications.ListQualificationsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`search`	string	optional	Search params
`job`	string	optional

services.qualifications.ListQualificationsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`qualifications`	resources.qualifications.Qualification	repeated

services.qualifications.ListQualificationsResultsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`qualification_id`	int64	optional	Search params
`status`	resources.qualifications.ResultStatus	repeated
`user_ids`	int32	repeated

services.qualifications.ListQualificationsResultsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`results`	resources.qualifications.QualificationResult	repeated

services.qualifications.SetQualificationAccessRequest

Field	Type	Label	Description
`qualification_id`	int64
`access`	resources.access.Access

services.qualifications.SetQualificationAccessResponse

services.qualifications.UpdateQualificationRequest

Field	Type	Label	Description
`qualification`	resources.qualifications.Qualification

services.qualifications.UpdateQualificationResponse

Field	Type	Label	Description
`qualification_id`	int64

services.qualifications.QualificationsService

Method Name	Request Type	Response Type
`ListQualifications`	ListQualificationsRequest	ListQualificationsResponse
`GetQualification`	GetQualificationRequest	GetQualificationResponse
`CreateQualification`	CreateQualificationRequest	CreateQualificationResponse
`UpdateQualification`	UpdateQualificationRequest	UpdateQualificationResponse
`DeleteQualification`	DeleteQualificationRequest	DeleteQualificationResponse
`ListQualificationRequests`	ListQualificationRequestsRequest	ListQualificationRequestsResponse
`CreateOrUpdateQualificationRequest`	CreateOrUpdateQualificationRequestRequest	CreateOrUpdateQualificationRequestResponse
`DeleteQualificationReq`	DeleteQualificationReqRequest	DeleteQualificationReqResponse
`ListQualificationsResults`	ListQualificationsResultsRequest	ListQualificationsResultsResponse
`CreateOrUpdateQualificationResult`	CreateOrUpdateQualificationResultRequest	CreateOrUpdateQualificationResultResponse
`DeleteQualificationResult`	DeleteQualificationResultRequest	DeleteQualificationResultResponse
`UploadFile`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse

services/settings/accounts.proto

services.settings.CreateAccountRequest

Field	Type	Label	Description
`license`	string
`username`	string
`last_char`	int32	optional
`char`	resources.users.short.UserShort	optional	Allow creating a char at the same time (only when dbsync is used)

services.settings.CreateAccountResponse

Field	Type	Label	Description
`reg_token`	string

services.settings.DeleteAccountRequest

Field	Type	Label	Description
`id`	int64

services.settings.DeleteAccountResponse

Field	Type	Label	Description
`deleted_at`	resources.timestamp.Timestamp	optional

services.settings.DisconnectSocialLoginRequest

Field	Type	Label	Description
`id`	int64
`provider_name`	string

services.settings.DisconnectSocialLoginResponse

services.settings.ListAccountsRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`license`	string	optional	Search params
`only_disabled`	bool	optional
`username`	string	optional
`external_id`	string	optional
`group`	string	optional

services.settings.ListAccountsResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`accounts`	resources.accounts.Account	repeated

services.settings.UpdateAccountRequest

Field	Type	Label
`id`	int64
`enabled`	bool	optional
`last_char`	int32	optional

services.settings.UpdateAccountResponse

Field	Type	Label	Description
`account`	resources.accounts.Account

services.settings.AccountsService

Method Name	Request Type	Response Type
`ListAccounts`	ListAccountsRequest	ListAccountsResponse
`CreateAccount`	CreateAccountRequest	CreateAccountResponse
`UpdateAccount`	UpdateAccountRequest	UpdateAccountResponse
`DisconnectSocialLogin`	DisconnectSocialLoginRequest	DisconnectSocialLoginResponse
`DeleteAccount`	DeleteAccountRequest	DeleteAccountResponse

Field	Type	Label	Description
`config`	resources.settings.AppConfig

services.settings.UpdateAppConfigRequest

Field	Type	Label	Description
`config`	resources.settings.AppConfig

services.settings.UpdateAppConfigResponse

Field	Type	Label	Description
`config`	resources.settings.AppConfig

services.settings.ConfigService

Method Name	Request Type	Response Type	Description
`GetAppConfig`	GetAppConfigRequest	GetAppConfigResponse
`UpdateAppConfig`	UpdateAppConfigRequest	UpdateAppConfigResponse

Field	Type	Label	Description
`jobs`	resources.cron.Cronjob	repeated

services.settings.RunCronjobRequest

Field	Type	Label	Description
`name`	string

services.settings.RunCronjobResponse

Field	Type	Label	Description
`sequence`	uint64

services.settings.CronService

Method Name	Request Type	Response Type	Description
`ListCronjobs`	ListCronjobsRequest	ListCronjobsResponse
`RunCronjob`	RunCronjobRequest	RunCronjobResponse

services/settings/laws.proto

services.settings.CreateOrUpdateLawBookRequest

Field	Type	Label	Description
`law_book`	resources.laws.LawBook

services.settings.CreateOrUpdateLawBookResponse

Field	Type	Label	Description
`law_book`	resources.laws.LawBook

services.settings.CreateOrUpdateLawRequest

Field	Type	Label	Description
`law`	resources.laws.Law

services.settings.CreateOrUpdateLawResponse

Field	Type	Label	Description
`law`	resources.laws.Law

services.settings.DeleteLawBookRequest

Field	Type	Label	Description
`id`	int64

services.settings.DeleteLawBookResponse

Field	Type	Label	Description
`deleted_at`	resources.timestamp.Timestamp	optional

services.settings.DeleteLawRequest

Field	Type	Label	Description
`id`	int64

services.settings.DeleteLawResponse

Field	Type	Label	Description
`deleted_at`	resources.timestamp.Timestamp	optional

services.settings.ListLawBooksRequest

services.settings.ListLawBooksResponse

Field	Type	Label	Description
`books`	resources.laws.LawBook	repeated

services.settings.ReorderLawBooksRequest

Field	Type	Label	Description
`law_book_ids`	int64	repeated

services.settings.ReorderLawBooksResponse

services.settings.ReorderLawsRequest

Field	Type	Label	Description
`law_book_id`	int64
`law_ids`	int64	repeated

services.settings.ReorderLawsResponse

services.settings.LawsService

Method Name	Request Type	Response Type
`ListLawBooks`	ListLawBooksRequest	ListLawBooksResponse
`CreateOrUpdateLawBook`	CreateOrUpdateLawBookRequest	CreateOrUpdateLawBookResponse
`DeleteLawBook`	DeleteLawBookRequest	DeleteLawBookResponse
`ReorderLawBooks`	ReorderLawBooksRequest	ReorderLawBooksResponse
`CreateOrUpdateLaw`	CreateOrUpdateLawRequest	CreateOrUpdateLawResponse
`DeleteLaw`	DeleteLawRequest	DeleteLawResponse
`ReorderLaws`	ReorderLawsRequest	ReorderLawsResponse

services/settings/settings.proto

services.settings.CreateRoleRequest

Field	Type	Label	Description
`job`	string
`grade`	int32

services.settings.CreateRoleResponse

Field	Type	Label	Description
`role`	resources.permissions.permissions.Role

Field	Type	Label	Description
`id`	int64

services.settings.DeleteRoleResponse

services.settings.GetEffectivePermissionsRequest

Field	Type	Label	Description
`role_id`	int64

services.settings.GetEffectivePermissionsResponse

Field	Type	Label
`role`	resources.permissions.permissions.Role
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

services.settings.GetJobPropsRequest

services.settings.GetJobPropsResponse

Field	Type	Label	Description
`job_props`	resources.jobs.props.JobProps

services.settings.GetPermissionsRequest

Field	Type	Label	Description
`role_id`	int64

services.settings.GetPermissionsResponse

Field	Type	Label	Description
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

services.settings.GetRoleRequest

Field	Type	Label	Description
`id`	int64

services.settings.GetRoleResponse

Field	Type	Label	Description
`role`	resources.permissions.permissions.Role

services.settings.GetRolesRequest

Field	Type	Label	Description
`lowest_rank`	bool	optional

services.settings.GetRolesResponse

Field	Type	Label	Description
`roles`	resources.permissions.permissions.Role	repeated

services.settings.ListDiscordChannelsRequest

services.settings.ListDiscordChannelsResponse

Field	Type	Label	Description
`channels`	resources.discord.Channel	repeated

services.settings.ListUserGuildsRequest

services.settings.ListUserGuildsResponse

Field	Type	Label	Description
`guilds`	resources.discord.Guild	repeated

services.settings.SetJobPropsRequest

Field	Type	Label	Description
`job_props`	resources.jobs.props.JobProps

services.settings.SetJobPropsResponse

Field	Type	Label	Description
`job_props`	resources.jobs.props.JobProps

services.settings.UpdateRolePermsRequest

Field	Type	Label
`id`	int64
`perms`	resources.settings.PermsUpdate	optional
`attrs`	resources.settings.AttrsUpdate	optional

services.settings.UpdateRolePermsResponse

services.settings.ViewAuditLogRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`user_ids`	int32	repeated	Search params
`from`	resources.timestamp.Timestamp	optional
`to`	resources.timestamp.Timestamp	optional
`services`	string	repeated
`methods`	string	repeated
`search`	string	optional
`actions`	resources.audit.EventAction	repeated
`results`	resources.audit.EventResult	repeated

services.settings.ViewAuditLogResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`logs`	resources.audit.AuditEntry	repeated

services.settings.SettingsService

Method Name	Request Type	Response Type	Description
`GetJobProps`	GetJobPropsRequest	GetJobPropsResponse
`SetJobProps`	SetJobPropsRequest	SetJobPropsResponse
`GetRoles`	GetRolesRequest	GetRolesResponse
`GetRole`	GetRoleRequest	GetRoleResponse
`CreateRole`	CreateRoleRequest	CreateRoleResponse
`DeleteRole`	DeleteRoleRequest	DeleteRoleResponse
`UpdateRolePerms`	UpdateRolePermsRequest	UpdateRolePermsResponse
`GetPermissions`	GetPermissionsRequest	GetPermissionsResponse
`GetEffectivePermissions`	GetEffectivePermissionsRequest	GetEffectivePermissionsResponse
`ViewAuditLog`	ViewAuditLogRequest	ViewAuditLogResponse
`ListDiscordChannels`	ListDiscordChannelsRequest	ListDiscordChannelsResponse
`ListUserGuilds`	ListUserGuildsRequest	ListUserGuildsResponse
`UploadJobLogo`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
`DeleteJobLogo`	DeleteJobLogoRequest	DeleteJobLogoResponse

services/settings/system.proto

services.settings.DeleteFactionRequest

Field	Type	Label	Description
`job`	string

services.settings.DeleteFactionResponse

services.settings.GetAllPermissionsRequest

Field	Type	Label	Description
`job`	string

services.settings.GetAllPermissionsResponse

Field	Type	Label	Description
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

services.settings.GetJobLimitsRequest

Field	Type	Label	Description
`job`	string

services.settings.GetJobLimitsResponse

Field	Type	Label
`job`	string
`job_label`	string	optional
`permissions`	resources.permissions.permissions.Permission	repeated
`attributes`	resources.permissions.attributes.RoleAttribute	repeated

services.settings.GetStatusRequest

services.settings.GetStatusResponse

Field	Type	Label	Description
`status`	resources.settings.SystemStatus

services.settings.TriggerUserSyncRequest

Field	Type	Label	Description
`user_id`	int32

services.settings.TriggerUserSyncResponse

services.settings.UpdateJobLimitsRequest

Field	Type	Label
`job`	string
`perms`	resources.settings.PermsUpdate	optional
`attrs`	resources.settings.AttrsUpdate	optional

services.settings.UpdateJobLimitsResponse

services.settings.SystemService

Method Name	Request Type	Response Type
`GetStatus`	GetStatusRequest	GetStatusResponse
`GetAllPermissions`	GetAllPermissionsRequest	GetAllPermissionsResponse
`GetJobLimits`	GetJobLimitsRequest	GetJobLimitsResponse
`UpdateJobLimits`	UpdateJobLimitsRequest	UpdateJobLimitsResponse
`DeleteFaction`	DeleteFactionRequest	DeleteFactionResponse
`TriggerUserSync`	TriggerUserSyncRequest	TriggerUserSyncResponse

Field	Type	Label	Description
`stats`	GetPublicStatsResponse.StatsEntry	repeated

services.stats.GetPublicStatsResponse.StatsEntry

Field	Type	Label	Description
`key`	string
`value`	resources.stats.Stat

services.stats.StatsService

Method Name	Request Type	Response Type	Description
`GetPublicStats`	GetPublicStatsRequest	GetPublicStatsResponse

services/sync/sync.proto

services.sync.AddAccountUpdateRequest

Field	Type	Label	Description
`account_update`	resources.sync.activity.AccountUpdate

services.sync.AddActivityRequest

Field	Type	Description
`user_oauth2`	resources.sync.activity.UserOAuth2Conn
`dispatch`	resources.centrum.dispatches.Dispatch
`user_activity`	resources.users.activity.UserActivity	User activity
`user_props`	resources.sync.activity.UserProps	Setting props will cause activity to be created automtically
`colleague_activity`	resources.jobs.colleagues.activity.ColleagueActivity	Jobs user activity
`colleague_props`	resources.sync.activity.ColleagueProps	Setting props will cause activity to be created automtically
`job_timeclock`	resources.sync.activity.TimeclockUpdate	Timeclock user entry
`account_update`	resources.sync.activity.AccountUpdate	Account update for a signle account to update the group(s).
`user_update`	resources.sync.activity.UserUpdate	User/Char info updates that aren't tracked by activity (yet)

services.sync.AddActivityResponse

Field	Type	Label	Description
`id`	int64	optional
`created_at`	resources.timestamp.Timestamp	optional

services.sync.AddColleagueActivityRequest

Field	Type	Label	Description
`colleague_activity`	resources.jobs.colleagues.activity.ColleagueActivity

services.sync.AddColleaguePropsRequest

Field	Type	Label	Description
`colleague_props`	resources.sync.activity.ColleagueProps

services.sync.AddDispatchRequest

Field	Type	Label	Description
`dispatch`	resources.centrum.dispatches.Dispatch

services.sync.AddJobTimeclockRequest

Field	Type	Label	Description
`job_timeclock`	resources.sync.activity.TimeclockUpdate

services.sync.AddMarkerRequest

Field	Type	Label	Description
`marker`	resources.livemap.markers.MarkerMarker

services.sync.AddUserActivityRequest

Field	Type	Label	Description
`user_activity`	resources.users.activity.UserActivity

services.sync.AddUserOAuth2ConnRequest

Field	Type	Label	Description
`user_oauth2`	resources.sync.activity.UserOAuth2Conn

services.sync.AddUserPropsRequest

Field	Type	Label	Description
`user_props`	resources.sync.activity.UserProps

services.sync.AddUserUpdateRequest

Field	Type	Label	Description
`user_update`	resources.sync.activity.UserUpdate

services.sync.CloseUserDispatchesRequest

Request to close active dispatches created for a specific user.

Field	Type	Label	Description
`target_user_id`	int32		User ID whose active dispatches should be closed.
`limit_jobs`	string	repeated	Optional job list limiting which dispatch jobs are considered.
`coords`	resources.livemap.Coords	optional	Optional coordinates to attach to the closing dispatch status.
`reason`	string	optional	Optional reason to attach to the closing dispatch status.

services.sync.CloseUserDispatchesResponse

Response containing the number of dispatches closed for the user.

Field	Type	Label	Description
`rows_affected`	int64		Number of dispatches whose status was updated to completed.

services.sync.DeleteDataRequest

Field	Type	Label	Description
`users`	resources.sync.data.DeleteUsers
`vehicles`	resources.sync.data.DeleteVehicles

services.sync.DeleteDataResponse

Field	Type	Label	Description
`rows_affected`	int64

services.sync.DeleteMarkerRequest

Field	Type	Label	Description
`id`	int64

services.sync.DeleteUsersRequest

Field	Type	Label	Description
`user_ids`	int32	repeated

services.sync.DeleteVehiclesRequest

Field	Type	Label	Description
`plates`	string	repeated

services.sync.EndActiveJobTimeclocksRequest

services.sync.EndActiveJobTimeclocksResponse

Field	Type	Label	Description
`rows_affected`	int64

services.sync.GetStatusRequest

services.sync.GetStatusResponse

Field	Type	Label
`last_synced_data`	resources.timestamp.Timestamp	optional
`last_synced_activity`	resources.timestamp.Timestamp	optional
`jobs`	resources.sync.data.DataStatus
`licenses`	resources.sync.data.DataStatus
`users`	resources.sync.data.DataStatus
`vehicles`	resources.sync.data.DataStatus
`accounts`	resources.sync.data.DataStatus

services.sync.GetUserPropsRequest

Field	Type	Label	Description
`user_id`	int32

services.sync.GetUserPropsResponse

Field	Type	Label	Description
`user_props`	resources.users.props.UserProps

services.sync.RegisterAccountRequest

Field	Type	Label
`identifier`	string
`reset_token`	bool
`last_char_id`	int32	optional

services.sync.RegisterAccountResponse

Field	Type	Label
`reg_token`	string	optional
`account_id`	int64	optional
`username`	string	optional

services.sync.SendAccountsRequest

Field	Type	Label	Description
`account_updates`	resources.sync.activity.AccountUpdate	repeated
`clear`	bool

services.sync.SendDataRequest

Field	Type	Label	Description
`jobs`	resources.sync.data.DataJobs
`licenses`	resources.sync.data.DataLicenses
`accounts`	resources.sync.data.DataAccounts
`users`	resources.sync.data.DataUsers
`vehicles`	resources.sync.data.DataVehicles
`user_locations`	resources.sync.data.DataUserLocations
`last_char_id`	resources.sync.data.LastCharID

services.sync.SendDataResponse

Field	Type	Label	Description
`rows_affected`	int64

services.sync.SendJobsRequest

Field	Type	Label	Description
`jobs`	resources.jobs.Job	repeated

services.sync.SendLicensesRequest

Field	Type	Label	Description
`licenses`	resources.citizens.licenses.License	repeated

services.sync.SendUserLocationsRequest

Field	Type	Label	Description
`users`	resources.sync.data.CitizenLocations	repeated
`clear_all`	bool	optional

services.sync.SendUsersRequest

Field	Type	Label	Description
`users`	resources.sync.data.DataUser	repeated

services.sync.SendVehiclesRequest

Field	Type	Label	Description
`vehicles`	resources.vehicles.Vehicle	repeated

services.sync.SetLastCharIDRequest

Field	Type	Label	Description
`last_char_id`	resources.sync.data.LastCharID

services.sync.StreamRequest

Field	Type	Label	Description
`version`	string	optional

services.sync.StreamResponse

Field	Type	Label	Description
`user_id`	int32

services.sync.TransferAccountRequest

Field	Type	Label	Description
`old_license`	string
`new_license`	string

services.sync.TransferAccountResponse

services.sync.SyncService

Sync Service handles the sync of data (e.g., users, jobs) to this FiveNet instance and API calls from the plugin (e.g., user activity, user props changes).

Method Name	Request Type	Response Type	Description
`GetStatus`	GetStatusRequest	GetStatusResponse	Get basic "sync state" from server side (currently simply the count of records on the server side).
`RegisterAccount`	RegisterAccountRequest	RegisterAccountResponse	Get registration token for a new user account or return the account id and username, for a given identifier/license.
`TransferAccount`	TransferAccountRequest	TransferAccountResponse	Transfer account from one license to another
`AddUserOAuth2Conn`	AddUserOAuth2ConnRequest	AddActivityResponse	Add Discord OAuth2/social login connection for a user's account.
`AddAccountUpdate`	AddAccountUpdateRequest	AddActivityResponse	Record an account update activity.
`AddUserUpdate`	AddUserUpdateRequest	AddActivityResponse	Record a user update activity.
`AddUserActivity`	AddUserActivityRequest	AddActivityResponse	Record a user activity entry.
`AddUserProps`	AddUserPropsRequest	AddActivityResponse	Record user props changes.
`GetUserProps`	GetUserPropsRequest	GetUserPropsResponse	Retrieve user props.
`AddColleagueActivity`	AddColleagueActivityRequest	AddActivityResponse	Record a colleague activity entry.
`AddColleagueProps`	AddColleaguePropsRequest	AddActivityResponse	Record colleague props changes.
`AddJobTimeclock`	AddJobTimeclockRequest	AddActivityResponse	Record a job timeclock entry.
`AddDispatch`	AddDispatchRequest	AddActivityResponse	Record a dispatch activity entry.
`AddMarker`	AddMarkerRequest	AddActivityResponse	AddMarker Create a temporary marker on the live map (if no expiration time is provided, it will default to 24 hours).
`DeleteMarker`	DeleteMarkerRequest	DeleteDataResponse	Remove a temporary map marker.
`EndActiveJobTimeclocks`	EndActiveJobTimeclocksRequest	EndActiveJobTimeclocksResponse	End all active job timeclock entries, typically during server shutdown.
`CloseUserDispatches`	CloseUserDispatchesRequest	CloseUserDispatchesResponse	Close dispatch(es) that match a certain user, optionally limited to the given jobs.
`SendJobs`	SendJobsRequest	SendDataResponse	Sync job data to the server.
`SendLicenses`	SendLicensesRequest	SendDataResponse	Sync license data to the server.
`SendAccounts`	SendAccountsRequest	SendDataResponse	Sync account data to the server.
`SendUsers`	SendUsersRequest	SendDataResponse	Sync user data to the server.
`SendVehicles`	SendVehiclesRequest	SendDataResponse	Sync vehicle data to the server.
`SendUserLocations`	SendUserLocationsRequest	SendDataResponse	Sync user location data to the server.
`SetLastCharID`	SetLastCharIDRequest	SendDataResponse	Sync the last character ID for a user.
`DeleteUsers`	DeleteUsersRequest	DeleteDataResponse	Delete users from the sync store.
`DeleteVehicles`	DeleteVehiclesRequest	DeleteDataResponse	Delete vehicles from the sync store.
`Stream`	StreamRequest	StreamResponse stream	Used for the server to stream events to the dbsync (e.g., "refresh" of user/char data)
`AddActivity`	AddActivityRequest	AddActivityResponse	DEPRECATED: For "tracking" activity such as "user received traffic infraction points", timeclock entries, etc.
`SendData`	SendDataRequest	SendDataResponse	DEPRECATED: DBSync's method of sending (mass) data to the FiveNet server for storing.
`DeleteData`	DeleteDataRequest	DeleteDataResponse	DEPRECATED: Way for the gameserver to delete certain data as well

services/vehicles/vehicles.proto

services.vehicles.ListVehicleActivityRequest

Field	Type	Label
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`plate`	string
`types`	resources.vehicles.activity.VehicleActivityType	repeated

services.vehicles.ListVehicleActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.vehicles.activity.VehicleActivity	repeated

services.vehicles.ListVehiclesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`license_plate`	string	optional	Search params
`model`	string	optional
`user_ids`	int32	repeated
`job`	string	optional
`wanted`	bool	optional

services.vehicles.ListVehiclesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`vehicles`	resources.vehicles.Vehicle	repeated

services.vehicles.SetVehiclePropsRequest

Field	Type	Label	Description
`props`	resources.vehicles.props.VehicleProps
`reason`	string

services.vehicles.SetVehiclePropsResponse

Field	Type	Label	Description
`props`	resources.vehicles.props.VehicleProps

services.vehicles.VehiclesService

Method Name	Request Type	Response Type
`ListVehicles`	ListVehiclesRequest	ListVehiclesResponse
`SetVehicleProps`	SetVehiclePropsRequest	SetVehiclePropsResponse
`ListVehicleActivity`	ListVehicleActivityRequest	ListVehicleActivityResponse

services/wiki/collab.proto

services.wiki.CollabService

Method Name	Request Type	Response Type	Description
`JoinRoom`	.resources.collab.ClientPacket stream	.resources.collab.ServerPacket stream	buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_REQUEST_STANDARD_NAME buf:lint:ignore RPC_RESPONSE_STANDARD_NAME

services/wiki/wiki.proto

services.wiki.CreatePageRequest

Field	Type	Label	Description
`parent_id`	int64	optional
`content_type`	resources.common.content.ContentType

services.wiki.CreatePageResponse

Field	Type	Label	Description
`job`	string
`id`	int64

services.wiki.DeletePageRequest

Field	Type	Label	Description
`id`	int64

services.wiki.DeletePageResponse

services.wiki.GetPageRequest

Field	Type	Label	Description
`id`	int64

services.wiki.GetPageResponse

Field	Type	Label	Description
`page`	resources.wiki.Page

services.wiki.ListPageActivityRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`page_id`	int64

services.wiki.ListPageActivityResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`activity`	resources.wiki.activity.PageActivity	repeated

services.wiki.ListPagesRequest

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationRequest
`sort`	resources.common.database.Sort	optional
`job`	string	optional	Search params
`root_only`	bool	optional
`search`	string	optional

services.wiki.ListPagesResponse

Field	Type	Label	Description
`pagination`	resources.common.database.PaginationResponse
`pages`	resources.wiki.PageShort	repeated

services.wiki.MovePageRequest

Field	Type	Label
`page_id`	int64
`before_id`	int64	optional
`after_id`	int64	optional

services.wiki.MovePageResponse

services.wiki.UpdatePageRequest

Field	Type	Label	Description
`page`	resources.wiki.Page

services.wiki.UpdatePageResponse

Field	Type	Label	Description
`page`	resources.wiki.Page

services.wiki.WikiService

Method Name	Request Type	Response Type
`ListPages`	ListPagesRequest	ListPagesResponse
`GetPage`	GetPageRequest	GetPageResponse
`CreatePage`	CreatePageRequest	CreatePageResponse
`UpdatePage`	UpdatePageRequest	UpdatePageResponse
`DeletePage`	DeletePageRequest	DeletePageResponse
`MovePage`	MovePageRequest	MovePageResponse
`ListPageActivity`	ListPageActivityRequest	ListPageActivityResponse
`UploadFile`	.resources.file.UploadFileRequest stream	.resources.file.UploadFileResponse

Scalar Value Types

Notes	C++	Java	Python	Go	C#	PHP	Ruby
	double	double	float	float64	double	float	Float
	float	float	float	float32	float	float	Float
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
	bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
May contain any arbitrary sequence of bytes.	string	ByteString	str	byte	ByteString	string	String (ASCII-8BIT)

Development

Release Process

FiveNet follows Calendar Versioning aka CalVer for simpler continuous releases.