Skip to content

Latest commit

 

History

History
8282 lines (3598 loc) · 206 KB

grpc-api.md

File metadata and controls

8282 lines (3598 loc) · 206 KB

Protocol Documentation

Table of Contents

Top

resources/accounts/accounts.proto

Account

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
username string
license string

Top

resources/accounts/oauth2.proto

OAuth2Account

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

OAuth2Provider

Field Type Label Description
name string
label string
homepage string

Top

resources/centrum/dispatches.proto

Dispatch

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
job string
status DispatchStatus optional
message string @sanitize
description string optional @sanitize
attributes Attributes optional
x double
y double
postal string optional @sanitize
anon bool
creator_id int32 optional
creator resources.users.User optional
units DispatchAssignment repeated
references DispatchReferences optional

DispatchAssignment

Field Type Label Description
dispatch_id uint64 @gotags: sql:"primary_key" alias:"dispatch_id"
unit_id uint64 @gotags: sql:"primary_key" alias:"unit_id"
unit Unit optional
created_at resources.timestamp.Timestamp optional
expires_at resources.timestamp.Timestamp optional

DispatchAssignments

Field Type Label Description
dispatch_id uint64
job string
units DispatchAssignment repeated

DispatchReference

Field Type Label Description
target_dispatch_id uint64
reference_type DispatchReferenceType

DispatchReferences

Field Type Label Description
references DispatchReference repeated

DispatchStatus

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
dispatch_id uint64
unit_id uint64 optional
unit Unit optional
status StatusDispatch
reason string optional @sanitize
code string optional @sanitize
user_id int32 optional
user resources.users.UserShort optional
x double optional
y double optional
postal string optional @sanitize

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

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

TakeDispatchResp

Name Number Description
TAKE_DISPATCH_RESP_UNSPECIFIED 0
TAKE_DISPATCH_RESP_TIMEOUT 1
TAKE_DISPATCH_RESP_ACCEPTED 2
TAKE_DISPATCH_RESP_DECLINED 3

Top

resources/centrum/general.proto

Attributes

Field Type Label Description
list string repeated

Disponents

Field Type Label Description
job string
disponents resources.users.UserShort repeated

UserUnitMapping

Field Type Label Description
unit_id uint64
job string
user_id int32
created_at resources.timestamp.Timestamp

Top

resources/centrum/settings.proto

PredefinedStatus

Field Type Label Description
unit_status string repeated
dispatch_status string repeated

Settings

Field Type Label Description
job string
enabled bool
mode CentrumMode
fallback_mode CentrumMode
predefined_status PredefinedStatus optional
timings Timings

Timings

Field Type Label Description
dispatch_max_wait int64

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

Top

resources/centrum/units.proto

Unit

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
job string
name string @sanitize
initials string @sanitize
color string
description string optional @sanitize
status UnitStatus optional
users UnitAssignment repeated
attributes Attributes optional
home_postal string optional

UnitAssignment

Field Type Label Description
unit_id uint64 @gotags: sql:"primary_key" alias:"unit_id"
user_id int32 @gotags: sql:"primary_key" alias:"user_id"
user resources.users.UserShort optional

UnitAssignments

Field Type Label Description
unit_id uint64
job string
users UnitAssignment repeated

UnitStatus

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
unit_id uint64
unit Unit optional
status StatusUnit
reason string optional @sanitize
code string optional @sanitize
user_id int32 optional
user resources.users.UserShort optional
x double optional
y double optional
postal string optional @sanitize
creator_id int32 optional
creator resources.users.UserShort optional

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

Top

resources/common/database/database.proto

OrderBy

Field Type Label Description
column string
desc bool

PaginationRequest

Field Type Label Description
offset int64
page_size int64 optional

PaginationResponse

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

Top

resources/common/i18n.proto

TranslateItem

Field Type Label Description
key string
parameters TranslateItem.ParametersEntry repeated

TranslateItem.ParametersEntry

Field Type Label Description
key string
value string

Top

resources/documents/access.proto

DocumentAccess

Field Type Label Description
jobs DocumentJobAccess repeated @gotags: alias:"job_access"
users DocumentUserAccess repeated @gotags: alias:"user_access"

DocumentJobAccess

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp optional
document_id uint64
job string @gotags: alias:"job"
job_label string optional @gotags: alias:"job_label"
minimum_grade int32 @gotags: alias:"minimum_grade"
job_grade_label string optional @gotags: alias:"job_grade_label"
access AccessLevel @gotags: alias:"access"
required bool optional @gotags: alias:"required"

DocumentUserAccess

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp optional
document_id uint64
user_id int32
user resources.users.UserShort optional
access AccessLevel @gotags: alias:"access"
required bool optional @gotags: alias:"required"

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

AccessLevelUpdateMode

Name Number Description
ACCESS_LEVEL_UPDATE_MODE_UNSPECIFIED 0
ACCESS_LEVEL_UPDATE_MODE_UPDATE 1
ACCESS_LEVEL_UPDATE_MODE_DELETE 2
ACCESS_LEVEL_UPDATE_MODE_CLEAR 3

Top

resources/documents/activity.proto

DocAccessRequested

Field Type Label Description
level AccessLevel

DocActivity

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp
document_id uint64
activity_type DocActivityType
creator_id int32 optional
creator resources.users.UserShort optional @gotags: alias:"creator"
creator_job string
creator_job_label string optional
reason string optional
data DocActivityData

DocActivityData

Field Type Label Description
updated DocUpdated
owner_changed DocOwnerChanged
access_updated DocumentAccess
access_requested DocAccessRequested

DocOwnerChanged

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

DocUpdated

Field Type Label Description
title_diff string optional
content_diff string optional
state_diff string optional

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_COMMENT_ADDED 10 Comments
DOC_ACTIVITY_TYPE_COMMENT_UPDATED 11
DOC_ACTIVITY_TYPE_COMMENT_DELETED 12
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

Top

resources/documents/category.proto

Category

Field Type Label Description
id uint64
name string @sanitize
description string optional @sanitize
job string optional

Top

resources/documents/comment.proto

Comment

Field Type Label Description
id uint64 @gotags: alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
document_id uint64
comment string @sanitize: method=StripTags
creator_id int32 optional
creator resources.users.UserShort optional @gotags: alias:"creator"
creator_job string

Top

resources/documents/documents.proto

Document

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp
updated_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
category_id uint64 optional
category Category optional @gotags: alias:"category"
title string @sanitize
content_type DocContentType @gotags: alias:"content_type"
content string @sanitize
data string optional @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

Field Type Label Description
id uint64 optional
created_at resources.timestamp.Timestamp optional
source_document_id uint64 @gotags: alias:"source_document_id"
source_document DocumentShort optional @gotags: alias:"source_document"
reference DocReference @gotags: alias:"reference"
target_document_id uint64 @gotags: alias:"target_document_id"
target_document DocumentShort optional @gotags: alias:"target_document"
creator_id int32 optional @gotags: alias:"creator_id"
creator resources.users.UserShort optional @gotags: alias:"ref_creator"

DocumentRelation

Field Type Label Description
id uint64 optional
created_at resources.timestamp.Timestamp optional
document_id uint64
document DocumentShort optional @gotags: alias:"document"
source_user_id int32 @gotags: alias:"source_user_id"
source_user resources.users.UserShort optional @gotags: alias:"source_user"
relation DocRelation @gotags: alias:"relation"
target_user_id int32 @gotags: alias:"target_user_id"
target_user resources.users.UserShort optional @gotags: alias:"target_user"

DocumentShort

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp
updated_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
category_id uint64 optional
category Category optional @gotags: alias:"category"
title string @sanitize
content_type DocContentType @gotags: alias:"content_type"
content string @sanitize
creator_id int32 optional @gotags: alias:"creator_id"
creator resources.users.UserShort optional @gotags: alias:"creator"
creator_job string @gotags: alias:"creator_job"
state string @sanitize

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

DocContentType

Name Number Description
DOC_CONTENT_TYPE_UNSPECIFIED 0
DOC_CONTENT_TYPE_HTML 1
DOC_CONTENT_TYPE_PLAIN 2

DocReference

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

DocRelation

Name Number Description
DOC_RELATION_UNSPECIFIED 0
DOC_RELATION_MENTIONED 1
DOC_RELATION_TARGETS 2
DOC_RELATION_CAUSED 3

Top

resources/documents/requests.proto

DocRequest

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp
updated_at resources.timestamp.Timestamp
document_id uint64
request_type DocActivityType
creator_id int32 optional
creator resources.users.UserShort optional @gotags: alias:"creator"
creator_job string
creator_job_label string optional
reason string optional
data DocActivityData
accepted bool optional

Top

resources/documents/templates.proto

ObjectSpecs

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

Template

Field Type Label Description
id uint64 @gotags: alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
category Category @gotags: alias:"category"
weight uint32
title string @sanitize
description string @sanitize
content_title string @gotags: alias:"content_title"
content string @gotags: alias:"content"
state string @gotags: alias:"state"
schema TemplateSchema @gotags: alias:"schema"
creator_job string
creator_job_label string optional
job_access TemplateJobAccess repeated
content_access DocumentAccess @gotags: alias:"access"

TemplateData

Field Type Label Description
activeChar resources.users.User
documents DocumentShort repeated
users resources.users.UserShort repeated
vehicles resources.vehicles.Vehicle repeated

TemplateJobAccess

Field Type Label Description
id uint64 @gotags: alias:"id"
created_at resources.timestamp.Timestamp optional
template_id uint64 @gotags: alias:"template_id"
job string @gotags: alias:"job"
job_label string optional @gotags: alias:"job_label"
minimum_grade int32 @gotags: alias:"minimum_grade"
job_grade_label string optional @gotags: alias:"job_grade_label"
access AccessLevel @gotags: alias:"access"

TemplateRequirements

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

TemplateSchema

Field Type Label Description
requirements TemplateRequirements

TemplateShort

Field Type Label Description
id uint64 @gotags: alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
category Category @gotags: alias:"category"
weight uint32
title string @sanitize
description string @sanitize
schema TemplateSchema @gotags: alias:"schema"
creator_job string
creator_job_label string optional

Top

resources/jobs/colleagues.proto

Colleague

Field Type Label Description
user_id int32 @gotags: alias:"id"
identifier string
job string
job_label string optional
job_grade int32
job_grade_label string optional
firstname string
lastname string
dateofbirth string
phone_number string optional
avatar resources.filestore.File optional
props JobsUserProps @gotags: alias:"fivenet_jobs_user_props"

ColleagueAbsenceDate

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

ColleagueGradeChange

Field Type Label Description
grade int32
grade_label string

JobsUserActivity

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
job string
source_user_id int32
source_user Colleague @gotags: alias:"source_user"
target_user_id int32
target_user Colleague @gotags: alias:"target_user"
activity_type JobsUserActivityType
reason string @sanitize
data JobsUserActivityData

JobsUserActivityData

Field Type Label Description
absence_date ColleagueAbsenceDate
grade_change ColleagueGradeChange

JobsUserProps

Field Type Label Description
user_id int32
absence_begin resources.timestamp.Timestamp optional
absence_end resources.timestamp.Timestamp optional

JobsUserActivityType

Name Number Description
JOBS_USER_ACTIVITY_TYPE_UNSPECIFIED 0
JOBS_USER_ACTIVITY_TYPE_HIRED 1
JOBS_USER_ACTIVITY_TYPE_FIRED 2
JOBS_USER_ACTIVITY_TYPE_PROMOTED 3
JOBS_USER_ACTIVITY_TYPE_DEMOTED 4
JOBS_USER_ACTIVITY_TYPE_ABSENCE_DATE 5

Top

resources/jobs/conduct.proto

ConductEntry

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
job string
type ConductType
message string @sanitize
expires_at resources.timestamp.Timestamp optional
target_user_id int32
target_user Colleague optional @gotags: alias:"target_user"
creator_id int32
creator Colleague optional @gotags: alias:"creator"

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

Top

resources/jobs/timeclock.proto

TimeclockEntry

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

TimeclockStats

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

TimeclockWeeklyStats

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

Top

resources/laws/laws.proto

Law

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"law.id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
lawbook_id uint64
name string @sanitize
description string optional @sanitize
fine uint32 optional
detention_time uint32 optional
stvo_points uint32 optional

LawBook

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
name string @sanitize
description string optional @sanitize
laws Law repeated

Top

resources/livemap/livemap.proto

CircleMarker

Field Type Label Description
radius int32
opacity float optional

Coords

Field Type Label Description
x double
y double

IconMarker

Field Type Label Description
icon string

MarkerData

Field Type Label Description
circle CircleMarker
icon IconMarker

MarkerInfo

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
job string
job_label string
name string @sanitize
description string optional @sanitize
x double
y double
postal string optional @sanitize
color string optional
icon string optional

MarkerMarker

Field Type Label Description
info MarkerInfo
type MarkerType @gotags: alias:"markerType"
expires_at resources.timestamp.Timestamp optional
data MarkerData @gotags: alias:"markerData"
creator_id int32 optional
creator resources.users.UserShort optional

UserMarker

Field Type Label Description
info MarkerInfo
user_id int32
user resources.users.UserShort @gotags: alias:"user"
unit_id uint64 optional
unit resources.centrum.Unit optional

MarkerType

Name Number Description
MARKER_TYPE_UNSPECIFIED 0
MARKER_TYPE_DOT 1
MARKER_TYPE_CIRCLE 2
MARKER_TYPE_ICON 3

Top

resources/livemap/tracker.proto

UsersUpdateEvent

Field Type Label Description
added UserMarker repeated
removed UserMarker repeated

Top

resources/notifications/notifications.proto

Data

Field Type Label Description
link Link optional
caused_by resources.users.UserShort optional

Link

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

Notification

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp
read_at resources.timestamp.Timestamp
user_id int32
title resources.common.TranslateItem @sanitize
type string optional
content resources.common.TranslateItem @sanitize
category NotificationCategory
data Data optional
starred bool optional

NotificationCategory

Name Number Description
NOTIFICATION_CATEGORY_UNSPECIFIED 0
NOTIFICATION_CATEGORY_GENERAL 1
NOTIFICATION_CATEGORY_DOCUMENT 2

Top

resources/permissions/permissions.proto

AttributeValues

Field Type Label Description
string_list StringList
job_list StringList
job_grade_list JobGradeList

JobGradeList

Field Type Label Description
jobs JobGradeList.JobsEntry repeated

JobGradeList.JobsEntry

Field Type Label Description
key string
value int32

Permission

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp optional
category string
name string
guard_name string
val bool

RawRoleAttribute

Field Type Label Description
role_id uint64
created_at resources.timestamp.Timestamp optional
attr_id uint64
permission_id uint64
category string
name string
key string
type string
valid_values AttributeValues
value AttributeValues

Role

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

RoleAttribute

Field Type Label Description
role_id uint64
created_at resources.timestamp.Timestamp optional
attr_id uint64
permission_id uint64
category string
name string
key string
type string
valid_values AttributeValues
value AttributeValues
max_values AttributeValues optional

StringList

Field Type Label Description
strings string repeated

Top

resources/rector/audit.proto

AuditEntry

Field Type Label Description
id uint64 @gotags: alias:"id"
created_at resources.timestamp.Timestamp
user_id uint64 @gotags: alias:"user_id"
user resources.users.UserShort optional
user_job string @gotags: alias:"user_job"
target_user_id int32 optional @gotags: alias:"target_user_id"
target_user resources.users.UserShort optional
target_user_job string @gotags: alias:"target_user_job"
service string @gotags: alias:"service"
method string @gotags: alias:"method"
state EventType @gotags: alias:"state"
data string optional @gotags: alias:"data"

EventType

Name Number Description
EVENT_TYPE_UNSPECIFIED 0
EVENT_TYPE_ERRORED 1
EVENT_TYPE_VIEWED 2
EVENT_TYPE_CREATED 3
EVENT_TYPE_UPDATED 4
EVENT_TYPE_DELETED 5

Top

resources/rector/config.proto

AppConfig

Field Type Label Description
auth Auth
perms Perms
website Website
job_info JobInfo
user_tracker UserTracker
discord Discord

Auth

Field Type Label Description
signup_enabled bool

Discord

Field Type Label Description
enabled bool
sync_interval google.protobuf.Duration
invite_url string optional

JobInfo

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

Links

Field Type Label Description
privacy_policy string optional
imprint string optional

Perm

Field Type Label Description
category string
name string

Perms

Field Type Label Description
default Perm repeated

UnemployedJob

Field Type Label Description
name string
grade int32

UserTracker

Field Type Label Description
refresh_time google.protobuf.Duration
db_refresh_time google.protobuf.Duration
livemap_jobs string repeated

Website

Field Type Label Description
links Links

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

Field Type Label Description
timestamp google.protobuf.Timestamp

Top

resources/users/jobs.proto

DiscordSyncSettings

Field Type Label Description
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

GroupSyncSettings

Field Type Label Description
ignored_role_ids string repeated

Job

Field Type Label Description
name string @gotags: sql:"primary_key" alias:"name"
label string
grades JobGrade repeated

JobGrade

Field Type Label Description
job_name string optional
grade int32
label string

JobProps

Field Type Label Description
job string
job_label string optional
theme string
livemap_marker_color string
quick_buttons QuickButtons
radio_frequency string optional
discord_guild_id uint64 optional
discord_last_sync resources.timestamp.Timestamp optional
discord_sync_settings DiscordSyncSettings
motd string optional
logo_url resources.filestore.File optional
settings JobSettings

JobSettings

JobsAbsenceSettings

Field Type Label Description
absence_role string

QuickButtons

Field Type Label Description
penalty_calculator bool
body_checkup bool

StatusLogSettings

Field Type Label Description
channel_id string

UserInfoSyncSettings

Field Type Label Description
employee_role_enabled bool
employee_role_format string
grade_role_format string
unemployed_enabled bool
unemployed_mode UserInfoSyncUnemployedMode
unemployed_role_name string

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

Top

resources/users/users.proto

CitizenAttribute

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
job string optional
name string
color string

CitizenAttributes

Field Type Label Description
list CitizenAttribute repeated

License

Field Type Label Description
type string
label string

User

Field Type Label Description
user_id int32 @gotags: alias:"id"
identifier string
job string
job_label string optional
job_grade int32
job_grade_label string optional
firstname string
lastname string
dateofbirth string
sex string optional
height string optional
phone_number string optional
visum int32 optional
playtime int32 optional
props UserProps @gotags: alias:"fivenet_user_props"
licenses License repeated @gotags: alias:"user_licenses"
avatar resources.filestore.File optional

UserActivity

Field Type Label Description
id uint64 @gotags: alias:"fivenet_user_activity.id"
type UserActivityType @gotags: alias:"fivenet_user_activity.type"
created_at resources.timestamp.Timestamp @gotags: alias:"fivenet_user_activity.created_at"
source_user UserShort @gotags: alias:"source_user"
target_user UserShort @gotags: alias:"target_user"
key string @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

Field Type Label Description
user_id int32
wanted bool optional
job_name string optional @gotags: alias:"job"
job Job optional
job_grade_number int32 optional @gotags: alias:"job_grade"
job_grade JobGrade optional
traffic_infraction_points uint32 optional
open_fines int64 optional
blood_type string optional
mug_shot resources.filestore.File optional
attributes CitizenAttributes optional

UserShort

Field Type Label Description
user_id int32 @gotags: alias:"id"
identifier string
job string
job_label string optional
job_grade int32
job_grade_label string optional
firstname string
lastname string
dateofbirth string
phone_number string optional
avatar resources.filestore.File optional

UserActivityType

Name Number Description
USER_ACTIVITY_TYPE_UNSPECIFIED 0
USER_ACTIVITY_TYPE_CHANGED 1
USER_ACTIVITY_TYPE_MENTIONED 2
USER_ACTIVITY_TYPE_CREATED 3

Top

resources/vehicles/vehicles.proto

Vehicle

Field Type Label Description
plate string
model string optional
type string
owner resources.users.UserShort

Top

resources/filestore/file.proto

File

Field Type Label Description
url string optional
data bytes
delete bool optional
content_type string optional
extension string optional

FileInfo

Field Type Label Description
name string
last_modified resources.timestamp.Timestamp optional
size int64
content_type string

Top

resources/qualifications/qualifications.proto

Qualification

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
job string
weight uint32
closed bool
abbreviation string @sanitize: method=StripTags
title string @sanitize
description string optional @sanitize: method=StripTags
content string @sanitize
creator_id int32
creator resources.users.UserShort optional @gotags: alias:"creator"
creator_job string
access QualificationAccess
requirements QualificationRequirement repeated
discord_settings QualificationDiscordSettings optional
result QualificationResult optional
request QualificationRequest optional

QualificationAccess

Field Type Label Description
jobs QualificationJobAccess repeated

QualificationDiscordSettings

Field Type Label Description
sync_enabled bool
role_name string optional

QualificationJobAccess

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
qualification_id uint64
job string
job_label string optional
minimum_grade int32
job_grade_label string optional
access AccessLevel

QualificationRequest

Field Type Label Description
created_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
qualification_id uint64
qualification QualificationShort optional
user_id int32
user resources.users.UserShort @gotags: alias:"user"
user_comment string optional @sanitize: method=StripTags
status RequestStatus optional
approved_at resources.timestamp.Timestamp optional
approver_comment string optional @sanitize: method=StripTags
approver_id int32 optional
approver resources.users.UserShort optional @gotags: alias:"approver"
approver_job string optional

QualificationRequirement

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
qualification_id uint64
target_qualification_id uint64
target_qualification QualificationShort optional @gotags: alias:"targetqualification.*"

QualificationResult

Field Type Label Description
id uint64
created_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
qualification_id uint64
qualification QualificationShort optional
user_id int32
user resources.users.UserShort @gotags: alias:"user"
status ResultStatus
score uint32 optional
summary string @sanitize: method=StripTags
creator_id int32
creator resources.users.UserShort @gotags: alias:"creator"
creator_job string

QualificationShort

Field Type Label Description
id uint64 @gotags: sql:"primary_key" alias:"id"
created_at resources.timestamp.Timestamp optional
updated_at resources.timestamp.Timestamp optional
deleted_at resources.timestamp.Timestamp optional
job string
weight uint32
closed bool
abbreviation string @sanitize: method=StripTags
title string @sanitize
description string optional @sanitize: method=StripTags
creator_id int32
creator resources.users.UserShort optional @gotags: alias:"creator"
creator_job string
requirements QualificationRequirement repeated
result QualificationResult optional

QualificationTest

QualificationTestQuestion

Field Type Label Description
id uint64
qualification_id uint64
question string
data TestQuestionData

TestQuestionData

Field Type Label Description
separator bool
yesno bool
short_text TestQuestionDataText
long_text TestQuestionDataText
multiple_choice TestQuestionDataMultipleChoice

TestQuestionDataMultipleChoice

TODO

TestQuestionDataText

Field Type Label Description
min_length int32
max_length int32

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_MANAGE 6
ACCESS_LEVEL_EDIT 7

AccessLevelUpdateMode

Name Number Description
ACCESS_LEVEL_UPDATE_MODE_UNSPECIFIED 0
ACCESS_LEVEL_UPDATE_MODE_UPDATE 1
ACCESS_LEVEL_UPDATE_MODE_DELETE 2
ACCESS_LEVEL_UPDATE_MODE_CLEAR 3

RequestStatus

Name Number Description
REQUEST_STATUS_UNSPECIFIED 0
REQUEST_STATUS_PENDING 1
REQUEST_STATUS_DENIED 2
REQUEST_STATUS_ACCEPTED 3
REQUEST_STATUS_COMPLETED 4

ResultStatus

Name Number Description
RESULT_STATUS_UNSPECIFIED 0
RESULT_STATUS_PENDING 1
RESULT_STATUS_FAILED 2
RESULT_STATUS_SUCCESSFUL 3

Top

services/auth/auth.proto

ChangePasswordRequest

Field Type Label Description
current string
new string

ChangePasswordResponse

Field Type Label Description
token string
expires resources.timestamp.Timestamp

ChangeUsernameRequest

Field Type Label Description
current string
new string

ChangeUsernameResponse

ChooseCharacterRequest

Field Type Label Description
char_id int32

ChooseCharacterResponse

Field Type Label Description
token string
expires resources.timestamp.Timestamp
permissions string repeated
job_props resources.users.JobProps
char resources.users.User

CreateAccountRequest

Field Type Label Description
reg_token string
username string
password string

CreateAccountResponse

Field Type Label Description
account_id uint64

DeleteOAuth2ConnectionRequest

Field Type Label Description
provider string

DeleteOAuth2ConnectionResponse

Field Type Label Description
success bool

ForgotPasswordRequest

Field Type Label Description
reg_token string
new string

ForgotPasswordResponse

GetAccountInfoRequest

GetAccountInfoResponse

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

GetCharactersRequest

GetCharactersResponse

Field Type Label Description
chars resources.users.User repeated

LoginRequest

Field Type Label Description
username string
password string

LoginResponse

Field Type Label Description
token string
expires resources.timestamp.Timestamp
account_id uint64

LogoutRequest

LogoutResponse

Field Type Label Description
success bool

SetSuperUserModeRequest

Field Type Label Description
superuser bool
job string optional

SetSuperUserModeResponse

Field Type Label Description
token string
expires resources.timestamp.Timestamp
job_props resources.users.JobProps optional
char resources.users.User

AuthService

Method Name Request Type Response Type Description
Login LoginRequest LoginResponse
Logout LogoutRequest LogoutResponse
CreateAccount CreateAccountRequest CreateAccountResponse
ChangeUsername ChangeUsernameRequest ChangeUsernameResponse
ChangePassword ChangePasswordRequest ChangePasswordResponse
ForgotPassword ForgotPasswordRequest ForgotPasswordResponse
GetCharacters GetCharactersRequest GetCharactersResponse
ChooseCharacter ChooseCharacterRequest ChooseCharacterResponse @perm
GetAccountInfo GetAccountInfoRequest GetAccountInfoResponse
DeleteOAuth2Connection DeleteOAuth2ConnectionRequest DeleteOAuth2ConnectionResponse
SetSuperUserMode SetSuperUserModeRequest SetSuperUserModeResponse

Top

services/centrum/centrum.proto

AssignDispatchRequest

Field Type Label Description
dispatch_id uint64
to_add uint64 repeated
to_remove uint64 repeated
forced bool optional

AssignDispatchResponse

AssignUnitRequest

Field Type Label Description
unit_id uint64
to_add int32 repeated
to_remove int32 repeated

AssignUnitResponse

CreateDispatchRequest

Field Type Label Description
dispatch resources.centrum.Dispatch

CreateDispatchResponse

Field Type Label Description
dispatch resources.centrum.Dispatch

CreateOrUpdateUnitRequest

Field Type Label Description
unit resources.centrum.Unit

CreateOrUpdateUnitResponse

Field Type Label Description
unit resources.centrum.Unit

DeleteDispatchRequest

Field Type Label Description
id uint64

DeleteDispatchResponse

DeleteUnitRequest

Field Type Label Description
unit_id uint64

DeleteUnitResponse

GetDispatchRequest

Field Type Label Description
id uint64

GetDispatchResponse

Field Type Label Description
dispatch resources.centrum.Dispatch

GetSettingsRequest

GetSettingsResponse

Field Type Label Description
settings resources.centrum.Settings

JoinUnitRequest

Field Type Label Description
unit_id uint64 optional

JoinUnitResponse

Field Type Label Description
unit resources.centrum.Unit

LatestState

Field Type Label Description
server_time resources.timestamp.Timestamp
settings resources.centrum.Settings
disponents resources.users.UserShort repeated
own_unit_id uint64 optional
units resources.centrum.Unit repeated Send the current units and dispatches
dispatches resources.centrum.Dispatch repeated

ListDispatchActivityRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
id uint64

ListDispatchActivityResponse

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

ListDispatchesRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
status resources.centrum.StatusDispatch repeated
not_status resources.centrum.StatusDispatch repeated
ids uint64 repeated
postal string optional

ListDispatchesResponse

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

ListUnitActivityRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
id uint64

ListUnitActivityResponse

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

ListUnitsRequest

Field Type Label Description
status resources.centrum.StatusUnit repeated

ListUnitsResponse

Field Type Label Description
units resources.centrum.Unit repeated

StreamRequest

StreamResponse

Field Type Label Description
latest_state LatestState
settings resources.centrum.Settings
disponents resources.centrum.Disponents
unit_created resources.centrum.Unit
unit_deleted resources.centrum.Unit
unit_updated resources.centrum.Unit
unit_status resources.centrum.UnitStatus
dispatch_created resources.centrum.Dispatch
dispatch_deleted resources.centrum.Dispatch
dispatch_updated resources.centrum.Dispatch
dispatch_status resources.centrum.DispatchStatus

TakeControlRequest

Field Type Label Description
signon bool

TakeControlResponse

TakeDispatchRequest

Field Type Label Description
dispatch_ids uint64 repeated
resp resources.centrum.TakeDispatchResp
reason string optional @sanitize

TakeDispatchResponse

UpdateDispatchRequest

Field Type Label Description
dispatch resources.centrum.Dispatch

UpdateDispatchResponse

UpdateDispatchStatusRequest

Field Type Label Description
dispatch_id uint64
status resources.centrum.StatusDispatch
reason string optional @sanitize
code string optional @sanitize

UpdateDispatchStatusResponse

UpdateSettingsRequest

Field Type Label Description
settings resources.centrum.Settings

UpdateSettingsResponse

Field Type Label Description
settings resources.centrum.Settings

UpdateUnitStatusRequest

Field Type Label Description
unit_id uint64
status resources.centrum.StatusUnit
reason string optional @sanitize
code string optional @sanitize

UpdateUnitStatusResponse

CentrumService

Method Name Request Type Response Type Description
UpdateSettings UpdateSettingsRequest UpdateSettingsResponse @perm
CreateDispatch CreateDispatchRequest CreateDispatchResponse @perm
UpdateDispatch UpdateDispatchRequest UpdateDispatchResponse @perm
DeleteDispatch DeleteDispatchRequest DeleteDispatchResponse @perm
TakeControl TakeControlRequest TakeControlResponse @perm
AssignDispatch AssignDispatchRequest AssignDispatchResponse @perm: Name=TakeControl
AssignUnit AssignUnitRequest AssignUnitResponse @perm: Name=TakeControl
Stream StreamRequest StreamResponse stream @perm
GetSettings GetSettingsRequest GetSettingsResponse @perm: Name=Stream
JoinUnit JoinUnitRequest JoinUnitResponse @perm: Name=Stream
ListUnits ListUnitsRequest ListUnitsResponse @perm: Name=Stream
ListUnitActivity ListUnitActivityRequest ListUnitActivityResponse @perm: Name=Stream
GetDispatch GetDispatchRequest GetDispatchResponse @perm: Name=Stream
ListDispatches ListDispatchesRequest ListDispatchesResponse @perm: Name=Stream
ListDispatchActivity ListDispatchActivityRequest ListDispatchActivityResponse @perm: Name=Stream
CreateOrUpdateUnit CreateOrUpdateUnitRequest CreateOrUpdateUnitResponse @perm
DeleteUnit DeleteUnitRequest DeleteUnitResponse @perm
TakeDispatch TakeDispatchRequest TakeDispatchResponse @perm
UpdateUnitStatus UpdateUnitStatusRequest UpdateUnitStatusResponse @perm: Name=TakeDispatch
UpdateDispatchStatus UpdateDispatchStatusRequest UpdateDispatchStatusResponse @perm: Name=TakeDispatch

Top

services/citizenstore/citizenstore.proto

GetUserRequest

Field Type Label Description
user_id int32

GetUserResponse

Field Type Label Description
user resources.users.User

ListCitizensRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
search string Search params
wanted bool optional
phone_number string optional
traffic_infraction_points uint32 optional
dateofbirth string optional
open_fines uint64 optional

ListCitizensResponse

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

ListUserActivityRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
user_id int32

ListUserActivityResponse

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

ManageCitizenAttributesRequest

Field Type Label Description
attributes resources.users.CitizenAttribute repeated

ManageCitizenAttributesResponse

Field Type Label Description
attributes resources.users.CitizenAttribute repeated

SetProfilePictureRequest

Field Type Label Description
avatar resources.filestore.File

SetProfilePictureResponse

Field Type Label Description
avatar resources.filestore.File

SetUserPropsRequest

Field Type Label Description
props resources.users.UserProps
reason string @sanitize

SetUserPropsResponse

Field Type Label Description
props resources.users.UserProps

CitizenStoreService

Method Name Request Type Response Type Description
ListCitizens ListCitizensRequest ListCitizensResponse @perm: Attrs=Fields/StringList:[]string{"PhoneNumber", "Licenses", "UserProps.Wanted", "UserProps.Job", "UserProps.TrafficInfractionPoints", "UserProps.OpenFines", "UserProps.BloodType", "UserProps.MugShot", "UserProps.Attributes"}
GetUser GetUserRequest GetUserResponse @perm: Attrs=Jobs/JobGradeList
ListUserActivity ListUserActivityRequest ListUserActivityResponse @perm: Attrs=Fields/StringList:[]string{"SourceUser", "Own"}
SetUserProps SetUserPropsRequest SetUserPropsResponse @perm: Attrs=Fields/StringList:[]string{"Wanted", "Job", "TrafficInfractionPoints", "MugShot", "Attributes"}
SetProfilePicture SetProfilePictureRequest SetProfilePictureResponse @perm: Name=Any
ManageCitizenAttributes ManageCitizenAttributesRequest ManageCitizenAttributesResponse @perm

Top

services/completor/completor.proto

CompleteCitizenAttributesRequest

Field Type Label Description
search string

CompleteCitizenAttributesResponse

Field Type Label Description
attributes resources.users.CitizenAttribute repeated

CompleteCitizensRequest

Field Type Label Description
search string
current_job bool optional
on_duty bool optional
user_id int32 optional

CompleteCitizensRespoonse

Field Type Label Description
users resources.users.UserShort repeated @gotags: alias:"user"

CompleteDocumentCategoriesRequest

Field Type Label Description
search string

CompleteDocumentCategoriesResponse

Field Type Label Description
categories resources.documents.Category repeated

CompleteJobsRequest

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

CompleteJobsResponse

Field Type Label Description
jobs resources.users.Job repeated

ListLawBooksRequest

ListLawBooksResponse

Field Type Label Description
books resources.laws.LawBook repeated

CompletorService

Method Name Request Type Response Type Description
CompleteCitizens CompleteCitizensRequest CompleteCitizensRespoonse @perm
CompleteJobs CompleteJobsRequest CompleteJobsResponse @perm
CompleteDocumentCategories CompleteDocumentCategoriesRequest CompleteDocumentCategoriesResponse @perm: Attrs=Jobs/JobList
ListLawBooks ListLawBooksRequest ListLawBooksResponse @perm: Name=Any
CompleteCitizenAttributes CompleteCitizenAttributesRequest CompleteCitizenAttributesResponse @perm: Attrs=Jobs/JobList

Top

services/dmv/vehicles.proto

ListVehiclesRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
orderBy resources.common.database.OrderBy repeated
license_plate string optional Search params
model string optional
user_id int32 optional

ListVehiclesResponse

Field Type Label Description
pagination resources.common.database.PaginationResponse
vehicles resources.vehicles.Vehicle repeated

DMVService

Method Name Request Type Response Type Description
ListVehicles ListVehiclesRequest ListVehiclesResponse @perm

Top

services/docstore/docstore.proto

AddDocumentReferenceRequest

Field Type Label Description
reference resources.documents.DocumentReference

AddDocumentReferenceResponse

Field Type Label Description
id uint64

AddDocumentRelationRequest

Field Type Label Description
relation resources.documents.DocumentRelation

AddDocumentRelationResponse

Field Type Label Description
id uint64

ChangeDocumentOwnerRequest

Field Type Label Description
document_id uint64
new_user_id int32 optional

ChangeDocumentOwnerResponse

CreateCategoryRequest

Field Type Label Description
category resources.documents.Category

CreateCategoryResponse

Field Type Label Description
id uint64

CreateDocumentReqRequest

Field Type Label Description
document_id uint64
request_type resources.documents.DocActivityType
reason string optional @sanitize
data resources.documents.DocActivityData optional

CreateDocumentReqResponse

Field Type Label Description
request resources.documents.DocRequest

CreateDocumentRequest

Field Type Label Description
category_id uint64 optional @gotags: alias:"category_id"
title string @sanitize: method=StripTags

@gotags: alias:"title" | | content | string | | @sanitize

@gotags: alias:"content" | | content_type | resources.documents.DocContentType | | @gotags: alias:"content_type" | | data | string | optional | @gotags: alias:"data" | | state | string | | @sanitize

@gotags: alias:"state" | | closed | bool | | @gotags: alias:"closed" | | public | bool | | @gotags: alias:"public" | | access | resources.documents.DocumentAccess | optional | | | template_id | uint64 | optional | |

CreateDocumentResponse

Field Type Label Description
document_id uint64 @gotags: alias:"id"

CreateTemplateRequest

Field Type Label Description
template resources.documents.Template

CreateTemplateResponse

Field Type Label Description
id uint64

DeleteCategoryRequest

Field Type Label Description
ids uint64 repeated

DeleteCategoryResponse

DeleteCommentRequest

Field Type Label Description
comment_id uint64

DeleteCommentResponse

DeleteDocumentReqRequest

Field Type Label Description
request_id uint64

DeleteDocumentReqResponse

DeleteDocumentRequest

Field Type Label Description
document_id uint64 @gotags: alias:"id"

DeleteDocumentResponse

DeleteTemplateRequest

Field Type Label Description
id uint64

DeleteTemplateResponse

EditCommentRequest

Field Type Label Description
comment resources.documents.Comment

EditCommentResponse

Field Type Label Description
comment resources.documents.Comment

GetCommentsRequest

Comments ===============================================================

Field Type Label Description
pagination resources.common.database.PaginationRequest
document_id uint64

GetCommentsResponse

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

GetDocumentAccessRequest

Access =====================================================================

Field Type Label Description
document_id uint64

GetDocumentAccessResponse

Field Type Label Description
access resources.documents.DocumentAccess

GetDocumentReferencesRequest

Field Type Label Description
document_id uint64

GetDocumentReferencesResponse

Field Type Label Description
references resources.documents.DocumentReference repeated @gotags: alias:"reference"

GetDocumentRelationsRequest

Field Type Label Description
document_id uint64

GetDocumentRelationsResponse

Field Type Label Description
relations resources.documents.DocumentRelation repeated @gotags: alias:"relation"

GetDocumentRequest

Field Type Label Description
document_id uint64

GetDocumentResponse

Field Type Label Description
document resources.documents.Document
access resources.documents.DocumentAccess

GetTemplateRequest

Field Type Label Description
template_id uint64
data resources.documents.TemplateData optional
render bool optional

GetTemplateResponse

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

ListCategoriesRequest

Categories

ListCategoriesResponse

Field Type Label Description
category resources.documents.Category repeated

ListDocumentActivityRequest

Document Activity and Requests =============================================

Field Type Label Description
pagination resources.common.database.PaginationRequest
document_id uint64
activity_types resources.documents.DocActivityType repeated Search

ListDocumentActivityResponse

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

ListDocumentReqsRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
document_id uint64

ListDocumentReqsResponse

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

ListDocumentsRequest

Documents ==================================================================

Field Type Label Description
pagination resources.common.database.PaginationRequest
orderBy resources.common.database.OrderBy repeated
search string optional Search params
category_ids uint64 repeated
creator_ids int32 repeated
from resources.timestamp.Timestamp optional
to resources.timestamp.Timestamp optional
closed bool optional
document_ids uint64 repeated

ListDocumentsResponse

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

ListTemplatesRequest

Templates ==================================================================

ListTemplatesResponse

Field Type Label Description
templates resources.documents.TemplateShort repeated

ListUserDocumentsRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
user_id int32
relations resources.documents.DocRelation repeated

ListUserDocumentsResponse

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

PostCommentRequest

Field Type Label Description
comment resources.documents.Comment

PostCommentResponse

Field Type Label Description
comment resources.documents.Comment

RemoveDocumentReferenceRequest

Field Type Label Description
id uint64

RemoveDocumentReferenceResponse

RemoveDocumentRelationRequest

Field Type Label Description
id uint64

RemoveDocumentRelationResponse

SetDocumentAccessRequest

Field Type Label Description
document_id uint64
mode resources.documents.AccessLevelUpdateMode
access resources.documents.DocumentAccess

SetDocumentAccessResponse

ToggleDocumentRequest

Field Type Label Description
document_id uint64
closed bool

ToggleDocumentResponse

UpdateCategoryRequest

Field Type Label Description
category resources.documents.Category

UpdateCategoryResponse

UpdateDocumentReqRequest

Field Type Label Description
document_id uint64
request_id uint64
reason string optional @sanitize
data resources.documents.DocActivityData optional
accepted bool

UpdateDocumentReqResponse

Field Type Label Description
request resources.documents.DocRequest

UpdateDocumentRequest

Field Type Label Description
document_id uint64 @gotags: alias:"id"
category_id uint64 optional @gotags: alias:"category_id"
title string @sanitize: method=StripTags

@gotags: alias:"title" | | content | string | | @sanitize

@gotags: alias:"content" | | content_type | resources.documents.DocContentType | | @gotags: alias:"content_type" | | data | string | optional | @gotags: alias:"data" | | state | string | | @sanitize

@gotags: alias:"state" | | closed | bool | | @gotags: alias:"closed" | | public | bool | | @gotags: alias:"public" | | access | resources.documents.DocumentAccess | optional | |

UpdateDocumentResponse

Field Type Label Description
document_id uint64 @gotags: alias:"id"

UpdateTemplateRequest

Field Type Label Description
template resources.documents.Template

UpdateTemplateResponse

Field Type Label Description
template resources.documents.Template

DocStoreService

Method Name Request Type Response Type Description
ListTemplates ListTemplatesRequest ListTemplatesResponse @perm
GetTemplate GetTemplateRequest GetTemplateResponse @perm: Name=ListTemplates
CreateTemplate CreateTemplateRequest CreateTemplateResponse @perm
UpdateTemplate UpdateTemplateRequest UpdateTemplateResponse @perm: Name=CreateTemplate
DeleteTemplate DeleteTemplateRequest DeleteTemplateResponse @perm
ListDocuments ListDocumentsRequest ListDocumentsResponse @perm
GetDocument GetDocumentRequest GetDocumentResponse @perm
CreateDocument CreateDocumentRequest CreateDocumentResponse @perm
UpdateDocument UpdateDocumentRequest UpdateDocumentResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
DeleteDocument DeleteDocumentRequest DeleteDocumentResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
ToggleDocument ToggleDocumentRequest ToggleDocumentResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
ChangeDocumentOwner ChangeDocumentOwnerRequest ChangeDocumentOwnerResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
GetDocumentReferences GetDocumentReferencesRequest GetDocumentReferencesResponse @perm: Name=GetDocument
GetDocumentRelations GetDocumentRelationsRequest GetDocumentRelationsResponse @perm: Name=GetDocument
AddDocumentReference AddDocumentReferenceRequest AddDocumentReferenceResponse @perm
RemoveDocumentReference RemoveDocumentReferenceRequest RemoveDocumentReferenceResponse @perm: Name=AddDocumentReference
AddDocumentRelation AddDocumentRelationRequest AddDocumentRelationResponse @perm
RemoveDocumentRelation RemoveDocumentRelationRequest RemoveDocumentRelationResponse @perm: Name=AddDocumentRelation
GetComments GetCommentsRequest GetCommentsResponse @perm: Name=GetDocument
PostComment PostCommentRequest PostCommentResponse @perm
EditComment EditCommentRequest EditCommentResponse @perm: Name=PostComment
DeleteComment DeleteCommentRequest DeleteCommentResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
GetDocumentAccess GetDocumentAccessRequest GetDocumentAccessResponse @perm: Name=GetDocument
SetDocumentAccess SetDocumentAccessRequest SetDocumentAccessResponse @perm: Name=CreateDocument
ListDocumentActivity ListDocumentActivityRequest ListDocumentActivityResponse @perm
ListDocumentReqs ListDocumentReqsRequest ListDocumentReqsResponse @perm
CreateDocumentReq CreateDocumentReqRequest CreateDocumentReqResponse @perm: Attrs=Types/StringList:[]string{"Access", "Closure", "Update", "Deletion", "OwnerChange"}
UpdateDocumentReq UpdateDocumentReqRequest UpdateDocumentReqResponse @perm: Name=CreateDocumentReq
DeleteDocumentReq DeleteDocumentReqRequest DeleteDocumentReqResponse @perm
ListUserDocuments ListUserDocumentsRequest ListUserDocumentsResponse @perm
ListCategories ListCategoriesRequest ListCategoriesResponse @perm
CreateCategory CreateCategoryRequest CreateCategoryResponse @perm
UpdateCategory UpdateCategoryRequest UpdateCategoryResponse @perm: Name=CreateCategory
DeleteCategory DeleteCategoryRequest DeleteCategoryResponse @perm

Top

services/jobs/conduct.proto

CreateConductEntryRequest

Field Type Label Description
entry resources.jobs.ConductEntry

CreateConductEntryResponse

Field Type Label Description
entry resources.jobs.ConductEntry

DeleteConductEntryRequest

Field Type Label Description
id uint64

DeleteConductEntryResponse

ListConductEntriesRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
types resources.jobs.ConductType repeated Search params
show_expired bool optional
user_ids int32 repeated

ListConductEntriesResponse

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

UpdateConductEntryRequest

Field Type Label Description
entry resources.jobs.ConductEntry

UpdateConductEntryResponse

Field Type Label Description
entry resources.jobs.ConductEntry

JobsConductService

Method Name Request Type Response Type Description
ListConductEntries ListConductEntriesRequest ListConductEntriesResponse @perm: Attrs=Access/StringList:[]string{"Own", "All"}
CreateConductEntry CreateConductEntryRequest CreateConductEntryResponse @perm
UpdateConductEntry UpdateConductEntryRequest UpdateConductEntryResponse @perm
DeleteConductEntry DeleteConductEntryRequest DeleteConductEntryResponse @perm

Top

services/jobs/jobs.proto

GetColleagueRequest

Field Type Label Description
user_id int32

GetColleagueResponse

Field Type Label Description
colleague resources.jobs.Colleague

GetMOTDRequest

GetMOTDResponse

Field Type Label Description
motd string

GetSelfRequest

GetSelfResponse

Field Type Label Description
colleague resources.jobs.Colleague

ListColleagueActivityRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
user_ids int32 repeated

ListColleagueActivityResponse

Field Type Label Description
pagination resources.common.database.PaginationResponse
activity resources.jobs.JobsUserActivity repeated

ListColleaguesRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
search string Search params
user_id int32 optional
absent bool optional

ListColleaguesResponse

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

SetJobsUserPropsRequest

Field Type Label Description
props resources.jobs.JobsUserProps
reason string @sanitize

SetJobsUserPropsResponse

Field Type Label Description
props resources.jobs.JobsUserProps

SetMOTDRequest

Field Type Label Description
motd string @sanitize: method=StripTags

SetMOTDResponse

Field Type Label Description
motd string

JobsService

Method Name Request Type Response Type Description
ListColleagues ListColleaguesRequest ListColleaguesResponse @perm
GetSelf GetSelfRequest GetSelfResponse @perm: Name=ListColleagues
GetColleague GetColleagueRequest GetColleagueResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
ListColleagueActivity ListColleagueActivityRequest ListColleagueActivityResponse @perm: Attrs=Types/StringList:[]string{"HIRED", "FIRED", "PROMOTED", "DEMOTED", "ABSENCE_DATE"}
SetJobsUserProps SetJobsUserPropsRequest SetJobsUserPropsResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
GetMOTD GetMOTDRequest GetMOTDResponse @perm: Name=Any
SetMOTD SetMOTDRequest SetMOTDResponse @perm

Top

services/jobs/timeclock.proto

GetTimeclockStatsRequest

Field Type Label Description
user_id int32 optional

GetTimeclockStatsResponse

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

ListInactiveEmployeesRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
days int32

ListInactiveEmployeesResponse

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

ListTimeclockRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
user_ids int32 repeated Search
from resources.timestamp.Timestamp optional
to resources.timestamp.Timestamp optional
per_day bool optional

ListTimeclockResponse

Field Type Label Description
pagination resources.common.database.PaginationResponse
entries resources.jobs.TimeclockEntry repeated
stats resources.jobs.TimeclockStats
weekly resources.jobs.TimeclockWeeklyStats repeated

JobsTimeclockService

Method Name Request Type Response Type Description
ListTimeclock ListTimeclockRequest ListTimeclockResponse @perm: Attrs=Access/StringList:[]string{"All"}
GetTimeclockStats GetTimeclockStatsRequest GetTimeclockStatsResponse @perm: Name=ListTimeclock
ListInactiveEmployees ListInactiveEmployeesRequest ListInactiveEmployeesResponse @perm

Top

services/livemapper/livemap.proto

CreateOrUpdateMarkerRequest

Field Type Label Description
marker resources.livemap.MarkerMarker

CreateOrUpdateMarkerResponse

Field Type Label Description
marker resources.livemap.MarkerMarker

DeleteMarkerRequest

Field Type Label Description
id uint64

DeleteMarkerResponse

JobsList

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

MarkerMarkersUpdates

Field Type Label Description
markers resources.livemap.MarkerMarker repeated

StreamRequest

StreamResponse

Field Type Label Description
jobs JobsList
markers MarkerMarkersUpdates
users UserMarkersUpdates

UserMarkersUpdates

Field Type Label Description
users resources.livemap.UserMarker repeated
part int32

LivemapperService

Method Name Request Type Response Type Description
Stream StreamRequest StreamResponse stream @perm: Attrs=Markers/JobList
CreateOrUpdateMarker CreateOrUpdateMarkerRequest CreateOrUpdateMarkerResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
DeleteMarker DeleteMarkerRequest DeleteMarkerResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}

Top

services/notificator/notificator.proto

GetNotificationsRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
include_read bool optional

GetNotificationsResponse

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

MarkNotificationsRequest

Field Type Label Description
ids uint64 repeated
all bool optional

MarkNotificationsResponse

Field Type Label Description
updated uint64

StreamRequest

StreamResponse

Field Type Label Description
notification_count int32
restart bool optional
notification resources.notifications.Notification
token TokenUpdate

TokenUpdate

Field Type Label Description
new_token string optional
expires resources.timestamp.Timestamp
permissions string repeated
user_info resources.users.User optional
job_props resources.users.JobProps optional

NotificatorService

Method Name Request Type Response Type Description
GetNotifications GetNotificationsRequest GetNotificationsResponse @perm: Name=Any
MarkNotifications MarkNotificationsRequest MarkNotificationsResponse @perm: Name=Any
Stream StreamRequest StreamResponse stream @perm: Name=Any

Top

services/rector/config.proto

GetAppConfigRequest

GetAppConfigResponse

Field Type Label Description
config resources.rector.AppConfig

UpdateAppConfigRequest

Field Type Label Description
config resources.rector.AppConfig

UpdateAppConfigResponse

Field Type Label Description
config resources.rector.AppConfig

RectorConfigService

Method Name Request Type Response Type Description
GetAppConfig GetAppConfigRequest GetAppConfigResponse @perm: Name=SuperUser
UpdateAppConfig UpdateAppConfigRequest UpdateAppConfigResponse @perm: Name=SuperUser

Top

services/rector/filestore.proto

DeleteFileRequest

Field Type Label Description
path string

DeleteFileResponse

ListFilesRequest

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

ListFilesResponse

Field Type Label Description
pagination resources.common.database.PaginationResponse
files resources.filestore.FileInfo repeated

UploadFileRequest

Field Type Label Description
prefix string
name string
file resources.filestore.File

UploadFileResponse

Field Type Label Description
file resources.filestore.FileInfo

RectorFilestoreService

Method Name Request Type Response Type Description
ListFiles ListFilesRequest ListFilesResponse @perm: Name=SuperUser
UploadFile UploadFileRequest UploadFileResponse @perm: Name=SuperUser
DeleteFile DeleteFileRequest DeleteFileResponse @perm: Name=SuperUser

Top

services/rector/laws.proto

CreateOrUpdateLawBookRequest

Field Type Label Description
lawBook resources.laws.LawBook

CreateOrUpdateLawBookResponse

Field Type Label Description
lawBook resources.laws.LawBook

CreateOrUpdateLawRequest

Field Type Label Description
law resources.laws.Law

CreateOrUpdateLawResponse

Field Type Label Description
law resources.laws.Law

DeleteLawBookRequest

Field Type Label Description
id uint64

DeleteLawBookResponse

DeleteLawRequest

Field Type Label Description
id uint64

DeleteLawResponse

RectorLawsService

Method Name Request Type Response Type Description
CreateOrUpdateLawBook CreateOrUpdateLawBookRequest CreateOrUpdateLawBookResponse @perm: Name=SuperUser
DeleteLawBook DeleteLawBookRequest DeleteLawBookResponse @perm: Name=SuperUser
CreateOrUpdateLaw CreateOrUpdateLawRequest CreateOrUpdateLawResponse @perm: Name=SuperUser
DeleteLaw DeleteLawRequest DeleteLawResponse @perm: Name=SuperUser

Top

services/rector/rector.proto

AttrsUpdate

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

CreateRoleRequest

Field Type Label Description
job string
grade int32

CreateRoleResponse

Field Type Label Description
role resources.permissions.Role

DeleteRoleRequest

Field Type Label Description
id uint64

DeleteRoleResponse

GetJobPropsRequest

GetJobPropsResponse

Field Type Label Description
job_props resources.users.JobProps

GetPermissionsRequest

Field Type Label Description
role_id uint64
filtered bool optional

GetPermissionsResponse

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

GetRoleRequest

Field Type Label Description
id uint64
filtered bool optional

GetRoleResponse

Field Type Label Description
role resources.permissions.Role

GetRolesRequest

Field Type Label Description
lowest_rank bool optional

GetRolesResponse

Field Type Label Description
roles resources.permissions.Role repeated

PermItem

Field Type Label Description
id uint64
val bool

PermsUpdate

Field Type Label Description
to_update PermItem repeated
to_remove uint64 repeated

SetJobPropsRequest

Field Type Label Description
job_props resources.users.JobProps

SetJobPropsResponse

Field Type Label Description
job_props resources.users.JobProps

UpdateRoleLimitsRequest

Field Type Label Description
role_id uint64
perms PermsUpdate optional
attrs AttrsUpdate optional

UpdateRoleLimitsResponse

UpdateRolePermsRequest

Field Type Label Description
id uint64
perms PermsUpdate optional
attrs AttrsUpdate optional

UpdateRolePermsResponse

ViewAuditLogRequest

Field Type Label Description
pagination resources.common.database.PaginationRequest
user_ids int32 repeated
from resources.timestamp.Timestamp optional
to resources.timestamp.Timestamp optional
service string optional
method string optional
search string optional

ViewAuditLogResponse

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

RectorService

Method Name Request Type Response Type Description
GetJobProps GetJobPropsRequest GetJobPropsResponse @perm
SetJobProps SetJobPropsRequest SetJobPropsResponse @perm
GetRoles GetRolesRequest GetRolesResponse @perm
GetRole GetRoleRequest GetRoleResponse @perm: Name=GetRoles
CreateRole CreateRoleRequest CreateRoleResponse @perm
DeleteRole DeleteRoleRequest DeleteRoleResponse @perm
UpdateRolePerms UpdateRolePermsRequest UpdateRolePermsResponse @perm
GetPermissions GetPermissionsRequest GetPermissionsResponse @perm: Name=GetRoles
ViewAuditLog ViewAuditLogRequest ViewAuditLogResponse @perm
UpdateRoleLimits UpdateRoleLimitsRequest UpdateRoleLimitsResponse @perm: Name=SuperUser

Top

services/qualifications/qualifications.proto

CreateOrUpdateQualificationRequestRequest

Field Type Label Description
request resources.qualifications.QualificationRequest

CreateOrUpdateQualificationRequestResponse

Field Type Label Description
request resources.qualifications.QualificationRequest

CreateOrUpdateQualificationResultRequest

Field Type Label Description
result resources.qualifications.QualificationResult

CreateOrUpdateQualificationResultResponse

Field Type Label Description
result resources.qualifications.QualificationResult

CreateQualificationRequest

Field Type Label Description
qualification resources.qualifications.Qualification

CreateQualificationResponse

Field Type Label Description
qualification_id uint64

DeleteQualificationReqRequest

Field Type Label Description
qualification_id uint64
user_id int32

DeleteQualificationReqResponse

DeleteQualificationRequest

Field Type Label Description
qualification_id uint64

DeleteQualificationResponse

DeleteQualificationResultRequest

Field Type Label Description
result_id uint64

DeleteQualificationResultResponse

GetQualificationAccessRequest

Access =====================================================================

Field Type Label Description
qualification_id uint64

GetQualificationAccessResponse

Field Type Label Description
access resources.qualifications.QualificationAccess

GetQualificationRequest

Field Type Label Description
qualification_id uint64

GetQualificationResponse

Field Type Label Description
qualification resources.qualifications.Qualification

ListQualificationRequestsRequest

Requests ===================================================================

Field Type Label Description
pagination resources.common.database.PaginationRequest
qualification_id uint64 optional Search params
status resources.qualifications.RequestStatus repeated

ListQualificationRequestsResponse

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

ListQualificationsRequest

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

ListQualificationsResponse

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

ListQualificationsResultsRequest

Results ====================================================================

Field Type Label Description
pagination resources.common.database.PaginationRequest
qualification_id uint64 optional Search params
status resources.qualifications.ResultStatus repeated
user_id int32 optional

ListQualificationsResultsResponse

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

SetQualificationAccessRequest

Field Type Label Description
qualification_id uint64
mode resources.qualifications.AccessLevelUpdateMode
access resources.qualifications.QualificationAccess

SetQualificationAccessResponse

UpdateQualificationRequest

Field Type Label Description
qualification resources.qualifications.Qualification

UpdateQualificationResponse

Field Type Label Description
qualification_id uint64

QualificationsService

Method Name Request Type Response Type Description
ListQualifications ListQualificationsRequest ListQualificationsResponse @perm
GetQualification GetQualificationRequest GetQualificationResponse @perm
CreateQualification CreateQualificationRequest CreateQualificationResponse @perm
UpdateQualification UpdateQualificationRequest UpdateQualificationResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
DeleteQualification DeleteQualificationRequest DeleteQualificationResponse @perm: Attrs=Access/StringList:[]string{"Own", "Lower_Rank", "Same_Rank", "Any"}
ListQualificationRequests ListQualificationRequestsRequest ListQualificationRequestsResponse @perm: Name=GetQualification
CreateOrUpdateQualificationRequest CreateOrUpdateQualificationRequestRequest CreateOrUpdateQualificationRequestResponse @perm: Name=GetQualification
DeleteQualificationReq DeleteQualificationReqRequest DeleteQualificationReqResponse @perm
ListQualificationsResults ListQualificationsResultsRequest ListQualificationsResultsResponse @perm: Name=GetQualification
CreateOrUpdateQualificationResult CreateOrUpdateQualificationResultRequest CreateOrUpdateQualificationResultResponse @perm
DeleteQualificationResult DeleteQualificationResultRequest DeleteQualificationResultResponse @perm

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 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)
int64 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
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 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)
sint64 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
fixed32 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)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)