Development

Protocol Documentation

Protocol Documentation

Table of Contents

Top

resources/accounts/accounts.proto

Account

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
usernamestring
licensestring

Top

resources/accounts/oauth2.proto

OAuth2Account

FieldTypeLabelDescription
account_iduint64
created_atresources.timestamp.Timestampoptional
provider_namestring
providerOAuth2Provider
external_iduint64
usernamestring
avatarstring

OAuth2Provider

FieldTypeLabelDescription
namestring
labelstring
homepagestring

Top

resources/centrum/general.proto

Attributes

FieldTypeLabelDescription
liststringrepeated

Disponents

FieldTypeLabelDescription
jobstring
disponentsresources.users.UserShortrepeated

UserUnitMapping

FieldTypeLabelDescription
unit_iduint64
jobstring
user_idint32
created_atresources.timestamp.Timestamp

Top

resources/centrum/units.proto

Unit

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
jobstring
namestring@sanitize
initialsstring@sanitize
colorstring
descriptionstringoptional@sanitize
statusUnitStatusoptional
usersUnitAssignmentrepeated
attributesAttributesoptional
home_postalstringoptional

UnitAssignment

FieldTypeLabelDescription
unit_iduint64@gotags: sql:"primary_key" alias:"unit_id"
user_idint32@gotags: sql:"primary_key" alias:"user_id"
userresources.users.UserShortoptional

UnitAssignments

FieldTypeLabelDescription
unit_iduint64
jobstring
usersUnitAssignmentrepeated

UnitStatus

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
unit_iduint64
unitUnitoptional
statusStatusUnit
reasonstringoptional@sanitize
codestringoptional@sanitize
user_idint32optional
userresources.users.UserShortoptional
xdoubleoptional
ydoubleoptional
postalstringoptional@sanitize
creator_idint32optional
creatorresources.users.UserShortoptional

StatusUnit

NameNumberDescription
STATUS_UNIT_UNSPECIFIED0
STATUS_UNIT_UNKNOWN1
STATUS_UNIT_USER_ADDED2
STATUS_UNIT_USER_REMOVED3
STATUS_UNIT_UNAVAILABLE4
STATUS_UNIT_AVAILABLE5
STATUS_UNIT_ON_BREAK6
STATUS_UNIT_BUSY7

Top

resources/centrum/settings.proto

PredefinedStatus

FieldTypeLabelDescription
unit_statusstringrepeated
dispatch_statusstringrepeated

Settings

FieldTypeLabelDescription
jobstring
enabledbool
modeCentrumMode
fallback_modeCentrumMode
predefined_statusPredefinedStatusoptional

CentrumMode

NameNumberDescription
CENTRUM_MODE_UNSPECIFIED0
CENTRUM_MODE_MANUAL1
CENTRUM_MODE_CENTRAL_COMMAND2
CENTRUM_MODE_AUTO_ROUND_ROBIN3
CENTRUM_MODE_SIMPLIFIED4

Top

resources/centrum/dispatches.proto

Dispatch

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
jobstring
statusDispatchStatusoptional
messagestring@sanitize
descriptionstringoptional@sanitize
attributesAttributesoptional
xdouble
ydouble
postalstringoptional@sanitize
anonbool
creator_idint32optional
creatorresources.users.Useroptional
unitsDispatchAssignmentrepeated
referencesDispatchReferencesoptional

DispatchAssignment

FieldTypeLabelDescription
dispatch_iduint64@gotags: sql:"primary_key" alias:"dispatch_id"
unit_iduint64@gotags: sql:"primary_key" alias:"unit_id"
unitUnitoptional
created_atresources.timestamp.Timestampoptional
expires_atresources.timestamp.Timestampoptional

DispatchAssignments

FieldTypeLabelDescription
dispatch_iduint64
jobstring
unitsDispatchAssignmentrepeated

DispatchReference

FieldTypeLabelDescription
target_dispatch_iduint64
reference_typeDispatchReferenceType

DispatchReferences

FieldTypeLabelDescription
referencesDispatchReferencerepeated

DispatchStatus

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
dispatch_iduint64
unit_iduint64optional
unitUnitoptional
statusStatusDispatch
reasonstringoptional@sanitize
codestringoptional@sanitize
user_idint32optional
userresources.users.UserShortoptional
xdoubleoptional
ydoubleoptional
postalstringoptional@sanitize

DispatchReferenceType

NameNumberDescription
DISPATCH_REFERENCE_TYPE_UNSPECIFIED0
DISPATCH_REFERENCE_TYPE_REFERENCED1
DISPATCH_REFERENCE_TYPE_DUPLICATED_BY2
DISPATCH_REFERENCE_TYPE_DUPLICATE_OF3

StatusDispatch

NameNumberDescription
STATUS_DISPATCH_UNSPECIFIED0
STATUS_DISPATCH_NEW1
STATUS_DISPATCH_UNASSIGNED2
STATUS_DISPATCH_UPDATED3
STATUS_DISPATCH_UNIT_ASSIGNED4
STATUS_DISPATCH_UNIT_UNASSIGNED5
STATUS_DISPATCH_UNIT_ACCEPTED6
STATUS_DISPATCH_UNIT_DECLINED7
STATUS_DISPATCH_EN_ROUTE8
STATUS_DISPATCH_ON_SCENE9
STATUS_DISPATCH_NEED_ASSISTANCE10
STATUS_DISPATCH_COMPLETED11
STATUS_DISPATCH_CANCELLED12
STATUS_DISPATCH_ARCHIVED13

TakeDispatchResp

NameNumberDescription
TAKE_DISPATCH_RESP_UNSPECIFIED0
TAKE_DISPATCH_RESP_TIMEOUT1
TAKE_DISPATCH_RESP_ACCEPTED2
TAKE_DISPATCH_RESP_DECLINED3

Top

resources/common/database/database.proto

OrderBy

FieldTypeLabelDescription
columnstring
descbool

PaginationRequest

FieldTypeLabelDescription
offsetint64
page_sizeint64optional

PaginationResponse

FieldTypeLabelDescription
total_countint64
offsetint64
endint64
page_sizeint64

Top

resources/common/i18n.proto

TranslateItem

FieldTypeLabelDescription
keystring
parametersTranslateItem.ParametersEntryrepeated

TranslateItem.ParametersEntry

FieldTypeLabelDescription
keystring
valuestring

Top

resources/documents/category.proto

Category

FieldTypeLabelDescription
iduint64
namestring@sanitize
descriptionstringoptional@sanitize
jobstringoptional

Top

resources/documents/requests.proto

DocRequest

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestamp
updated_atresources.timestamp.Timestamp
document_iduint64
request_typeDocActivityType
creator_idint32optional
creatorresources.users.UserShortoptional@gotags: alias:"creator"
creator_jobstring
creator_job_labelstringoptional
reasonstringoptional
dataDocActivityData
acceptedbooloptional

Top

resources/documents/activity.proto

DocAccessRequested

FieldTypeLabelDescription
levelAccessLevel

DocActivity

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestamp
document_iduint64
activity_typeDocActivityType
creator_idint32optional
creatorresources.users.UserShortoptional@gotags: alias:"creator"
creator_jobstring
creator_job_labelstringoptional
reasonstringoptional
dataDocActivityData

DocActivityData

FieldTypeLabelDescription
updatedDocUpdated
owner_changedDocOwnerChanged
access_updatedDocumentAccess
access_requestedDocAccessRequested

DocOwnerChanged

FieldTypeLabelDescription
new_owner_idint32
new_ownerresources.users.UserShort

DocUpdated

FieldTypeLabelDescription
title_diffstringoptional
content_diffstringoptional
state_diffstringoptional

DocActivityType

NameNumberDescription
DOC_ACTIVITY_TYPE_UNSPECIFIED0
DOC_ACTIVITY_TYPE_CREATED1Base
DOC_ACTIVITY_TYPE_STATUS_OPEN2
DOC_ACTIVITY_TYPE_STATUS_CLOSED3
DOC_ACTIVITY_TYPE_UPDATED4
DOC_ACTIVITY_TYPE_RELATIONS_UPDATED5
DOC_ACTIVITY_TYPE_REFERENCES_UPDATED6
DOC_ACTIVITY_TYPE_ACCESS_UPDATED7
DOC_ACTIVITY_TYPE_OWNER_CHANGED8
DOC_ACTIVITY_TYPE_DELETED9
DOC_ACTIVITY_TYPE_COMMENT_ADDED10Comments
DOC_ACTIVITY_TYPE_COMMENT_UPDATED11
DOC_ACTIVITY_TYPE_COMMENT_DELETED12
DOC_ACTIVITY_TYPE_REQUESTED_ACCESS13Requests
DOC_ACTIVITY_TYPE_REQUESTED_CLOSURE14
DOC_ACTIVITY_TYPE_REQUESTED_OPENING15
DOC_ACTIVITY_TYPE_REQUESTED_UPDATE16
DOC_ACTIVITY_TYPE_REQUESTED_OWNER_CHANGE17
DOC_ACTIVITY_TYPE_REQUESTED_DELETION18

Top

resources/documents/access.proto

DocumentAccess

FieldTypeLabelDescription
jobsDocumentJobAccessrepeated@gotags: alias:"job_access"
usersDocumentUserAccessrepeated@gotags: alias:"user_access"

DocumentJobAccess

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
document_iduint64
jobstring@gotags: alias:"job"
job_labelstringoptional@gotags: alias:"job_label"
minimum_gradeint32@gotags: alias:"minimum_grade"
job_grade_labelstringoptional@gotags: alias:"job_grade_label"
accessAccessLevel@gotags: alias:"access"
requiredbooloptional@gotags: alias:"required"

DocumentUserAccess

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
document_iduint64
user_idint32
userresources.users.UserShortoptional
accessAccessLevel@gotags: alias:"access"
requiredbooloptional@gotags: alias:"required"

AccessLevel

NameNumberDescription
ACCESS_LEVEL_UNSPECIFIED0
ACCESS_LEVEL_BLOCKED1
ACCESS_LEVEL_VIEW2
ACCESS_LEVEL_COMMENT3
ACCESS_LEVEL_STATUS4
ACCESS_LEVEL_ACCESS5
ACCESS_LEVEL_EDIT6

AccessLevelUpdateMode

NameNumberDescription
ACCESS_LEVEL_UPDATE_MODE_UNSPECIFIED0
ACCESS_LEVEL_UPDATE_MODE_UPDATE1
ACCESS_LEVEL_UPDATE_MODE_DELETE2
ACCESS_LEVEL_UPDATE_MODE_CLEAR3

Top

resources/documents/comment.proto

Comment

FieldTypeLabelDescription
iduint64@gotags: alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
document_iduint64
commentstring@sanitize: method=StripTags
creator_idint32optional
creatorresources.users.UserShortoptional@gotags: alias:"creator"
creator_jobstring

Top

resources/documents/documents.proto

Document

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestamp
updated_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
category_iduint64optional
categoryCategoryoptional@gotags: alias:"category"
titlestring@sanitize
content_typeDocContentType@gotags: alias:"content_type"
contentstring@sanitize
datastringoptional@sanitize

@gotags: alias:"data" | | creator_id | int32 | optional | @gotags: alias:"creator_id" | | creator | resources.users.UserShort | optional | @gotags: alias:"creator" | | creator_job | string | | | | state | string | | @sanitize | | closed | bool | | | | public | bool | | | | template_id | uint64 | optional | |

DocumentReference

FieldTypeLabelDescription
iduint64optional
created_atresources.timestamp.Timestampoptional
source_document_iduint64@gotags: alias:"source_document_id"
source_documentDocumentShortoptional@gotags: alias:"source_document"
referenceDocReference@gotags: alias:"reference"
target_document_iduint64@gotags: alias:"target_document_id"
target_documentDocumentShortoptional@gotags: alias:"target_document"
creator_idint32optional@gotags: alias:"creator_id"
creatorresources.users.UserShortoptional@gotags: alias:"ref_creator"

DocumentRelation

FieldTypeLabelDescription
iduint64optional
created_atresources.timestamp.Timestampoptional
document_iduint64
documentDocumentShortoptional@gotags: alias:"document"
source_user_idint32@gotags: alias:"source_user_id"
source_userresources.users.UserShortoptional@gotags: alias:"source_user"
relationDocRelation@gotags: alias:"relation"
target_user_idint32@gotags: alias:"target_user_id"
target_userresources.users.UserShortoptional@gotags: alias:"target_user"

DocumentShort

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestamp
updated_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
category_iduint64optional
categoryCategoryoptional@gotags: alias:"category"
titlestring@sanitize
content_typeDocContentType@gotags: alias:"content_type"
contentstring@sanitize
creator_idint32optional@gotags: alias:"creator_id"
creatorresources.users.UserShortoptional@gotags: alias:"creator"
creator_jobstring@gotags: alias:"creator_job"
statestring@sanitize

@gotags: alias:"state" | | closed | bool | | | | public | bool | | |

DocContentType

NameNumberDescription
DOC_CONTENT_TYPE_UNSPECIFIED0
DOC_CONTENT_TYPE_HTML1
DOC_CONTENT_TYPE_PLAIN2

DocReference

NameNumberDescription
DOC_REFERENCE_UNSPECIFIED0
DOC_REFERENCE_LINKED1
DOC_REFERENCE_SOLVES2
DOC_REFERENCE_CLOSES3
DOC_REFERENCE_DEPRECATES4

DocRelation

NameNumberDescription
DOC_RELATION_UNSPECIFIED0
DOC_RELATION_MENTIONED1
DOC_RELATION_TARGETS2
DOC_RELATION_CAUSED3

Top

resources/documents/templates.proto

ObjectSpecs

FieldTypeLabelDescription
requiredbooloptional
minint32optional
maxint32optional

Template

FieldTypeLabelDescription
iduint64@gotags: alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
categoryCategory@gotags: alias:"category"
weightuint32
titlestring@sanitize
descriptionstring@sanitize
content_titlestring@gotags: alias:"content_title"
contentstring@gotags: alias:"content"
statestring@gotags: alias:"state"
schemaTemplateSchema@gotags: alias:"schema"
creator_jobstring
creator_job_labelstringoptional
job_accessTemplateJobAccessrepeated
content_accessDocumentAccess@gotags: alias:"access"

TemplateData

FieldTypeLabelDescription
activeCharresources.users.User
documentsDocumentShortrepeated
usersresources.users.UserShortrepeated
vehiclesresources.vehicles.Vehiclerepeated

TemplateJobAccess

FieldTypeLabelDescription
iduint64@gotags: alias:"id"
created_atresources.timestamp.Timestampoptional
template_iduint64@gotags: alias:"template_id"
jobstring@gotags: alias:"job"
job_labelstringoptional@gotags: alias:"job_label"
minimum_gradeint32@gotags: alias:"minimum_grade"
job_grade_labelstringoptional@gotags: alias:"job_grade_label"
accessAccessLevel@gotags: alias:"access"

TemplateRequirements

FieldTypeLabelDescription
documentsObjectSpecsoptional
usersObjectSpecsoptional
vehiclesObjectSpecsoptional

TemplateSchema

FieldTypeLabelDescription
requirementsTemplateRequirements

TemplateShort

FieldTypeLabelDescription
iduint64@gotags: alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
categoryCategory@gotags: alias:"category"
weightuint32
titlestring@sanitize
descriptionstring@sanitize
schemaTemplateSchema@gotags: alias:"schema"
creator_jobstring
creator_job_labelstringoptional

Top

resources/jobs/colleagues.proto

Colleague

FieldTypeLabelDescription
user_idint32@gotags: alias:"id"
identifierstring
jobstring
job_labelstringoptional
job_gradeint32
job_grade_labelstringoptional
firstnamestring
lastnamestring
dateofbirthstring
phone_numberstringoptional
avatarresources.filestore.Fileoptional
propsJobsUserProps@gotags: alias:"fivenet_jobs_user_props"

ColleagueAbsenceDate

FieldTypeLabelDescription
absence_beginresources.timestamp.Timestamp
absence_endresources.timestamp.Timestamp

ColleagueGradeChange

FieldTypeLabelDescription
gradeint32
grade_labelstring

JobsUserActivity

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
jobstring
source_user_idint32
source_userColleague@gotags: alias:"source_user"
target_user_idint32
target_userColleague@gotags: alias:"target_user"
activity_typeJobsUserActivityType
reasonstring@sanitize
dataJobsUserActivityData

JobsUserActivityData

FieldTypeLabelDescription
absence_dateColleagueAbsenceDate
grade_changeColleagueGradeChange

JobsUserProps

FieldTypeLabelDescription
user_idint32
absence_beginresources.timestamp.Timestampoptional
absence_endresources.timestamp.Timestampoptional

JobsUserActivityType

NameNumberDescription
JOBS_USER_ACTIVITY_TYPE_UNSPECIFIED0
JOBS_USER_ACTIVITY_TYPE_HIRED1
JOBS_USER_ACTIVITY_TYPE_FIRED2
JOBS_USER_ACTIVITY_TYPE_PROMOTED3
JOBS_USER_ACTIVITY_TYPE_DEMOTED4
JOBS_USER_ACTIVITY_TYPE_ABSENCE_DATE5

Top

resources/jobs/conduct.proto

ConductEntry

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
jobstring
typeConductType
messagestring@sanitize
expires_atresources.timestamp.Timestampoptional
target_user_idint32
target_userColleagueoptional@gotags: alias:"target_user"
creator_idint32
creatorColleagueoptional@gotags: alias:"creator"

ConductType

NameNumberDescription
CONDUCT_TYPE_UNSPECIFIED0
CONDUCT_TYPE_NEUTRAL1
CONDUCT_TYPE_POSITIVE2
CONDUCT_TYPE_NEGATIVE3
CONDUCT_TYPE_WARNING4
CONDUCT_TYPE_SUSPENSION5
CONDUCT_TYPE_NOTE6

Top

resources/jobs/timeclock.proto

TimeclockEntry

FieldTypeLabelDescription
jobstring
dateresources.timestamp.Timestamp
user_idint32
userColleagueoptional
start_timeresources.timestamp.Timestampoptional
end_timeresources.timestamp.Timestampoptional
spent_timefloat

TimeclockStats

FieldTypeLabelDescription
jobstring
spent_time_sumfloat
spent_time_avgfloat
spent_time_maxfloat

TimeclockWeeklyStats

FieldTypeLabelDescription
yearint32
calendar_weekint32
sumfloat
avgfloat
maxfloat

Top

resources/laws/laws.proto

Law

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"law.id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
lawbook_iduint64
namestring@sanitize
descriptionstringoptional@sanitize
fineuint32optional
detention_timeuint32optional
stvo_pointsuint32optional

LawBook

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
namestring@sanitize
descriptionstringoptional@sanitize
lawsLawrepeated

Top

resources/livemap/tracker.proto

UsersUpdateEvent

FieldTypeLabelDescription
addedUserMarkerrepeated
removedUserMarkerrepeated

Top

resources/livemap/livemap.proto

CircleMarker

FieldTypeLabelDescription
radiusint32
oapcityfloatoptional

Coords

FieldTypeLabelDescription
xdouble
ydouble

IconMarker

FieldTypeLabelDescription
iconstring

MarkerData

FieldTypeLabelDescription
circleCircleMarker
iconIconMarker

MarkerInfo

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
jobstring
job_labelstring
namestring@sanitize
descriptionstringoptional@sanitize
xdouble
ydouble
postalstringoptional@sanitize
colorstringoptional
iconstringoptional

MarkerMarker

FieldTypeLabelDescription
infoMarkerInfo
typeMarkerType@gotags: alias:"markerType"
expires_atresources.timestamp.Timestampoptional
dataMarkerData@gotags: alias:"markerData"
creator_idint32optional
creatorresources.users.UserShortoptional

UserMarker

FieldTypeLabelDescription
infoMarkerInfo
user_idint32
userresources.users.UserShort@gotags: alias:"user"
unit_iduint64optional
unitresources.centrum.Unitoptional

MarkerType

NameNumberDescription
MARKER_TYPE_UNSPECIFIED0
MARKER_TYPE_DOT1
MARKER_TYPE_CIRCLE2
MARKER_TYPE_ICON3

Top

resources/notifications/notifications.proto

Data

FieldTypeLabelDescription
linkLinkoptional
caused_byresources.users.UserShortoptional

FieldTypeLabelDescription
tostring
titlestringoptional
externalbooloptional

Notification

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestamp
read_atresources.timestamp.Timestamp
user_idint32
titleresources.common.TranslateItem@sanitize
typestringoptional
contentresources.common.TranslateItem@sanitize
categoryNotificationCategory
dataDataoptional
starredbooloptional

NotificationCategory

NameNumberDescription
NOTIFICATION_CATEGORY_UNSPECIFIED0
NOTIFICATION_CATEGORY_GENERAL1
NOTIFICATION_CATEGORY_DOCUMENT2

Top

resources/permissions/permissions.proto

AttributeValues

FieldTypeLabelDescription
string_listStringList
job_listStringList
job_grade_listJobGradeList

JobGradeList

FieldTypeLabelDescription
jobsJobGradeList.JobsEntryrepeated

JobGradeList.JobsEntry

FieldTypeLabelDescription
keystring
valueint32

Permission

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
categorystring
namestring
guard_namestring
valbool

RawRoleAttribute

FieldTypeLabelDescription
role_iduint64
created_atresources.timestamp.Timestampoptional
attr_iduint64
permission_iduint64
categorystring
namestring
keystring
typestring
valid_valuesAttributeValues
valueAttributeValues

Role

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
jobstring
job_labelstringoptional
gradeint32
job_grade_labelstringoptional
permissionsPermissionrepeated
attributesRoleAttributerepeated

RoleAttribute

FieldTypeLabelDescription
role_iduint64
created_atresources.timestamp.Timestampoptional
attr_iduint64
permission_iduint64
categorystring
namestring
keystring
typestring
valid_valuesAttributeValues
valueAttributeValues
max_valuesAttributeValuesoptional

StringList

FieldTypeLabelDescription
stringsstringrepeated

Top

resources/rector/audit.proto

AuditEntry

FieldTypeLabelDescription
iduint64@gotags: alias:"id"
created_atresources.timestamp.Timestamp
user_iduint64@gotags: alias:"user_id"
userresources.users.UserShortoptional
user_jobstring@gotags: alias:"user_job"
target_user_idint32optional@gotags: alias:"target_user_id"
target_userresources.users.UserShortoptional
target_user_jobstring@gotags: alias:"target_user_job"
servicestring@gotags: alias:"service"
methodstring@gotags: alias:"method"
stateEventType@gotags: alias:"state"
datastringoptional@gotags: alias:"data"

EventType

NameNumberDescription
EVENT_TYPE_UNSPECIFIED0
EVENT_TYPE_ERRORED1
EVENT_TYPE_VIEWED2
EVENT_TYPE_CREATED3
EVENT_TYPE_UPDATED4
EVENT_TYPE_DELETED5

Top

resources/rector/config.proto

AppConfig

FieldTypeLabelDescription
authAuth
permsPerms
websiteWebsite
job_infoJobInfo
user_trackerUserTracker
discordDiscord

Auth

FieldTypeLabelDescription
signup_enabledbool

Discord

FieldTypeLabelDescription
enabledbool
sync_intervalgoogle.protobuf.Duration
invite_urlstringoptional

JobInfo

FieldTypeLabelDescription
unemployed_jobUnemployedJob
public_jobsstringrepeated
hidden_jobsstringrepeated

FieldTypeLabelDescription
privacy_policystringoptional
imprintstringoptional

Perm

FieldTypeLabelDescription
categorystring
namestring

Perms

FieldTypeLabelDescription
defaultPermrepeated

UnemployedJob

FieldTypeLabelDescription
namestring
gradeint32

UserTracker

FieldTypeLabelDescription
refresh_timegoogle.protobuf.Duration
db_refresh_timegoogle.protobuf.Duration
livemap_jobsstringrepeated

Website

FieldTypeLabelDescription
linksLinks

Top

resources/timestamp/timestamp.proto

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/#Scannerhttps://golang.org/pkg/database/sql/driver/#Valuer

FieldTypeLabelDescription
timestampgoogle.protobuf.Timestamp

Top

resources/users/users.proto

License

FieldTypeLabelDescription
typestring
labelstring

User

FieldTypeLabelDescription
user_idint32@gotags: alias:"id"
identifierstring
jobstring
job_labelstringoptional
job_gradeint32
job_grade_labelstringoptional
firstnamestring
lastnamestring
dateofbirthstring
sexstringoptional
heightstringoptional
phone_numberstringoptional
visumint32optional
playtimeint32optional
propsUserProps@gotags: alias:"fivenet_user_props"
licensesLicenserepeated@gotags: alias:"user_licenses"
avatarresources.filestore.Fileoptional

UserActivity

FieldTypeLabelDescription
iduint64@gotags: alias:"fivenet_user_activity.id"
typeUserActivityType@gotags: alias:"fivenet_user_activity.type"
created_atresources.timestamp.Timestamp@gotags: alias:"fivenet_user_activity.created_at"
source_userUserShort@gotags: alias:"source_user"
target_userUserShort@gotags: alias:"target_user"
keystring@sanitize

@gotags: alias:"fivenet_user_activity.key" | | old_value | string | | @gotags: alias:"fivenet_user_activity.old_value" | | new_value | string | | @gotags: alias:"fivenet_user_activity.new_value" | | reason | string | | @sanitize

@gotags: alias:"fivenet_user_activity.reason" |

UserProps

FieldTypeLabelDescription
user_idint32
wantedbooloptional
job_namestringoptional@gotags: alias:"job"
jobJoboptional
job_grade_numberint32optional@gotags: alias:"job_grade"
job_gradeJobGradeoptional
traffic_infraction_pointsuint32optional
open_finesint64optional
blood_typestringoptional
mug_shotresources.filestore.Fileoptional

UserShort

FieldTypeLabelDescription
user_idint32@gotags: alias:"id"
identifierstring
jobstring
job_labelstringoptional
job_gradeint32
job_grade_labelstringoptional
firstnamestring
lastnamestring
dateofbirthstring
phone_numberstringoptional
avatarresources.filestore.Fileoptional

UserActivityType

NameNumberDescription
USER_ACTIVITY_TYPE_UNSPECIFIED0
USER_ACTIVITY_TYPE_CHANGED1
USER_ACTIVITY_TYPE_MENTIONED2
USER_ACTIVITY_TYPE_CREATED3

Top

resources/users/jobs.proto

DiscordSyncSettings

FieldTypeLabelDescription
user_info_syncbool
user_info_sync_settingsUserInfoSyncSettingsoptional
status_logbool
status_log_settingsStatusLogSettingsoptional
jobs_absencebool
jobs_absence_settingsJobsAbsenceSettingsoptional

Job

FieldTypeLabelDescription
namestring@gotags: sql:"primary_key" alias:"name"
labelstring
gradesJobGraderepeated

JobGrade

FieldTypeLabelDescription
job_namestringoptional
gradeint32
labelstring

JobProps

FieldTypeLabelDescription
jobstring
job_labelstringoptional
themestring
livemap_marker_colorstring
quick_buttonsQuickButtons
radio_frequencystringoptional
discord_guild_iduint64optional
discord_last_syncresources.timestamp.Timestampoptional
discord_sync_settingsDiscordSyncSettings
motdstringoptional
logo_urlresources.filestore.Fileoptional
settingsJobSettings

JobSettings

JobsAbsenceSettings

FieldTypeLabelDescription
absence_rolestring

QuickButtons

FieldTypeLabelDescription
penalty_calculatorbool
body_checkupbool

StatusLogSettings

FieldTypeLabelDescription
channel_idstringoptional

UserInfoSyncSettings

FieldTypeLabelDescription
employee_role_enabledbool
employee_role_formatstringoptional
grade_role_formatstringoptional
unemployed_enabledbool
unemployed_modeUserInfoSyncUnemployedMode
unemployed_role_namestringoptional

UserInfoSyncUnemployedMode

NameNumberDescription
USER_INFO_SYNC_UNEMPLOYED_MODE_UNSPECIFIED0
USER_INFO_SYNC_UNEMPLOYED_MODE_GIVE_ROLE1
USER_INFO_SYNC_UNEMPLOYED_MODE_KICK2

Top

resources/vehicles/vehicles.proto

Vehicle

FieldTypeLabelDescription
platestring
modelstringoptional
typestring
ownerresources.users.UserShort

Top

resources/filestore/file.proto

File

FieldTypeLabelDescription
urlstringoptional
databytes
deletebooloptional
content_typestringoptional
extensionstringoptional

FileInfo

FieldTypeLabelDescription
namestring
last_modifiedresources.timestamp.Timestampoptional
sizeint64
content_typestring

Top

resources/qualifications/qualifications.proto

Qualification

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
jobstring
weightuint32
closedbool
abbreviationstring@sanitize: method=StripTags
titlestring@sanitize
descriptionstringoptional@sanitize: method=StripTags
contentstring@sanitize
creator_idint32
creatorresources.users.UserShortoptional@gotags: alias:"creator"
creator_jobstring
accessQualificationAccess
requirementsQualificationRequirementrepeated
discord_settingsQualificationDiscordSettingsoptional
resultQualificationResultoptional
requestQualificationRequestoptional

QualificationAccess

FieldTypeLabelDescription
jobsQualificationJobAccessrepeated

QualificationDiscordSettings

FieldTypeLabelDescription
sync_enabledbool
role_namestringoptional

QualificationJobAccess

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
qualification_iduint64
jobstring
job_labelstringoptional
minimum_gradeint32
job_grade_labelstringoptional
accessAccessLevel

QualificationRequest

FieldTypeLabelDescription
created_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
qualification_iduint64
qualificationQualificationShortoptional
user_idint32
userresources.users.UserShort@gotags: alias:"user"
user_commentstringoptional@sanitize: method=StripTags
statusRequestStatusoptional
approved_atresources.timestamp.Timestampoptional
approver_commentstringoptional@sanitize: method=StripTags
approver_idint32optional
approverresources.users.UserShortoptional@gotags: alias:"approver"
approver_jobstringoptional

QualificationRequirement

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
qualification_iduint64
target_qualification_iduint64
target_qualificationQualificationShortoptional@gotags: alias:"targetqualification.*"

QualificationResult

FieldTypeLabelDescription
iduint64
created_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
qualification_iduint64
qualificationQualificationShortoptional
user_idint32
userresources.users.UserShort@gotags: alias:"user"
statusResultStatus
scoreuint32optional
summarystring@sanitize: method=StripTags
creator_idint32
creatorresources.users.UserShort@gotags: alias:"creator"
creator_jobstring

QualificationShort

FieldTypeLabelDescription
iduint64@gotags: sql:"primary_key" alias:"id"
created_atresources.timestamp.Timestampoptional
updated_atresources.timestamp.Timestampoptional
deleted_atresources.timestamp.Timestampoptional
jobstring
weightuint32
closedbool
abbreviationstring@sanitize: method=StripTags
titlestring@sanitize
descriptionstringoptional@sanitize: method=StripTags
creator_idint32
creatorresources.users.UserShortoptional@gotags: alias:"creator"
creator_jobstring
requirementsQualificationRequirementrepeated
resultQualificationResultoptional

QualificationTest

QualificationTestQuestion

FieldTypeLabelDescription
iduint64
qualification_iduint64
questionstring
dataTestQuestionData

TestQuestionData

FieldTypeLabelDescription
separatorbool
yesnobool
short_textTestQuestionDataText
long_textTestQuestionDataText
multiple_choiceTestQuestionDataMultipleChoice

TestQuestionDataMultipleChoice

TODO

TestQuestionDataText

FieldTypeLabelDescription
min_lengthint32
max_lengthint32

AccessLevel

NameNumberDescription
ACCESS_LEVEL_UNSPECIFIED0
ACCESS_LEVEL_BLOCKED1
ACCESS_LEVEL_VIEW2
ACCESS_LEVEL_REQUEST3
ACCESS_LEVEL_TAKE4
ACCESS_LEVEL_GRADE5
ACCESS_LEVEL_MANAGE6
ACCESS_LEVEL_EDIT7

AccessLevelUpdateMode

NameNumberDescription
ACCESS_LEVEL_UPDATE_MODE_UNSPECIFIED0
ACCESS_LEVEL_UPDATE_MODE_UPDATE1
ACCESS_LEVEL_UPDATE_MODE_DELETE2
ACCESS_LEVEL_UPDATE_MODE_CLEAR3

RequestStatus

NameNumberDescription
REQUEST_STATUS_UNSPECIFIED0
REQUEST_STATUS_PENDING1
REQUEST_STATUS_DENIED2
REQUEST_STATUS_ACCEPTED3
REQUEST_STATUS_COMPLETED4

ResultStatus

NameNumberDescription
RESULT_STATUS_UNSPECIFIED0
RESULT_STATUS_PENDING1
RESULT_STATUS_FAILED2
RESULT_STATUS_SUCCESSFUL3

Top

services/auth/auth.proto

ChangePasswordRequest

FieldTypeLabelDescription
currentstring
newstring

ChangePasswordResponse

FieldTypeLabelDescription
tokenstring
expiresresources.timestamp.Timestamp

ChangeUsernameRequest

FieldTypeLabelDescription
currentstring
newstring

ChangeUsernameResponse

ChooseCharacterRequest

FieldTypeLabelDescription
char_idint32

ChooseCharacterResponse

FieldTypeLabelDescription
tokenstring
expiresresources.timestamp.Timestamp
permissionsstringrepeated
job_propsresources.users.JobProps
charresources.users.User

CreateAccountRequest

FieldTypeLabelDescription
reg_tokenstring
usernamestring
passwordstring

CreateAccountResponse

FieldTypeLabelDescription
account_iduint64

DeleteOAuth2ConnectionRequest

FieldTypeLabelDescription
providerstring

DeleteOAuth2ConnectionResponse

FieldTypeLabelDescription
successbool

ForgotPasswordRequest

FieldTypeLabelDescription
reg_tokenstring
newstring

ForgotPasswordResponse

GetAccountInfoRequest

GetAccountInfoResponse

FieldTypeLabelDescription
accountresources.accounts.Account
oauth2_providersresources.accounts.OAuth2Providerrepeated
oauth2_connectionsresources.accounts.OAuth2Accountrepeated

GetCharactersRequest

GetCharactersResponse

FieldTypeLabelDescription
charsresources.users.Userrepeated

LoginRequest

FieldTypeLabelDescription
usernamestring
passwordstring

LoginResponse

FieldTypeLabelDescription
tokenstring
expiresresources.timestamp.Timestamp
account_iduint64

LogoutRequest

LogoutResponse

FieldTypeLabelDescription
successbool

SetSuperUserModeRequest

FieldTypeLabelDescription
superuserbool
jobstringoptional

SetSuperUserModeResponse

FieldTypeLabelDescription
tokenstring
expiresresources.timestamp.Timestamp
job_propsresources.users.JobPropsoptional
charresources.users.User

AuthService

Method NameRequest TypeResponse TypeDescription
LoginLoginRequestLoginResponse
LogoutLogoutRequestLogoutResponse
CreateAccountCreateAccountRequestCreateAccountResponse
ChangeUsernameChangeUsernameRequestChangeUsernameResponse
ChangePasswordChangePasswordRequestChangePasswordResponse
ForgotPasswordForgotPasswordRequestForgotPasswordResponse
GetCharactersGetCharactersRequestGetCharactersResponse
ChooseCharacterChooseCharacterRequestChooseCharacterResponse@perm
GetAccountInfoGetAccountInfoRequestGetAccountInfoResponse
DeleteOAuth2ConnectionDeleteOAuth2ConnectionRequestDeleteOAuth2ConnectionResponse
SetSuperUserModeSetSuperUserModeRequestSetSuperUserModeResponse

Top

services/centrum/centrum.proto

AssignDispatchRequest

FieldTypeLabelDescription
dispatch_iduint64
to_adduint64repeated
to_removeuint64repeated
forcedbooloptional

AssignDispatchResponse

AssignUnitRequest

FieldTypeLabelDescription
unit_iduint64
to_addint32repeated
to_removeint32repeated

AssignUnitResponse

CreateDispatchRequest

FieldTypeLabelDescription
dispatchresources.centrum.Dispatch

CreateDispatchResponse

FieldTypeLabelDescription
dispatchresources.centrum.Dispatch

CreateOrUpdateUnitRequest

FieldTypeLabelDescription
unitresources.centrum.Unit

CreateOrUpdateUnitResponse

FieldTypeLabelDescription
unitresources.centrum.Unit

DeleteDispatchRequest

FieldTypeLabelDescription
iduint64

DeleteDispatchResponse

DeleteUnitRequest

FieldTypeLabelDescription
unit_iduint64

DeleteUnitResponse

GetDispatchRequest

FieldTypeLabelDescription
iduint64

GetDispatchResponse

FieldTypeLabelDescription
dispatchresources.centrum.Dispatch

GetSettingsRequest

GetSettingsResponse

FieldTypeLabelDescription
settingsresources.centrum.Settings

JoinUnitRequest

FieldTypeLabelDescription
unit_iduint64optional

JoinUnitResponse

FieldTypeLabelDescription
unitresources.centrum.Unit

LatestState

FieldTypeLabelDescription
server_timeresources.timestamp.Timestamp
settingsresources.centrum.Settings
disponentsresources.users.UserShortrepeated
own_unit_iduint64optional
unitsresources.centrum.UnitrepeatedSend the current units and dispatches
dispatchesresources.centrum.Dispatchrepeated

ListDispatchActivityRequest

FieldTypeLabelDescription
paginationresources.common.database.PaginationRequest
iduint64

ListDispatchActivityResponse

FieldTypeLabelDescription
paginationresources.common.database.PaginationResponse