Module: group_headers

Struct: EquipmentIcon

Key	Field	Type	Description	Requiredness	Default value
1	id	string	unique identifier for the icon	default
2	iconDocument	document.Document		default
3	descrip	string		default
200	latestChange	diff.Change		optional

An equipment icon for a tool/PPE needed

Struct: NoticeIcon

Key	Field	Type	Description	Requiredness	Default value
1	id	string	unique identifier for the icon	default
2	iconDocument	document.Document		default
3	descrip	string		default

Icon for notice header

Struct: IconDiff

Key	Field	Type	Description	Requiredness	Default value
1	latestChange	diff.Change		default
10	otherIcon	NoticeIcon		optional

Struct: NoticeHeader

Key	Field	Type	Description	Requiredness	Default value
1	id	string	unique identifier for this notice including description	default
2	icon	NoticeIcon		default
3	descrip	string	deprecated, use descripWrapper	default
4	descripWrapper	reference.StringWrapper		optional
100	descriptionDiff	diff.StringDiff		optional
101	iconDiff	IconDiff		optional
200	latestChange	diff.Change		optional

A notice represents a message at the top of a step group containing a standard icon and a description.

Struct: StepGroupCategory

Key	Field	Type	Description	Requiredness	Default value
1	id	string		default
2	name	string		default
3	color	string	6-digit hex RGB value w/ '#', e.g. #ff5599	default
4	archivedAt	i64		default

A step group category contains a color and name

Struct: StepGroupCategoryParams

Key	Field	Type	Description	Requiredness	Default value
1	name	string		optional
2	color	string	6-digit hex RGB value w/ '#', e.g. #ff5599	optional

Struct: CategoryDiff

Key	Field	Type	Description	Requiredness	Default value
1	latestChange	diff.Change		default
10	otherCategory	StepGroupCategory		optional

Struct: StepGroupHeaders

Key	Field	Type	Description	Requiredness	Default value
1	category	StepGroupCategory		optional
2	equipment	list<EquipmentIcon>		optional
3	notices	list<NoticeHeader>		optional
4	condition	string		optional
100	categoryDiff	CategoryDiff		optional
101	conditionDiff	diff.StringDiff		optional

Step group header contains the set of headers for a step group

Function: GroupHeaderContentService.indexEquipment

list<EquipmentIcon> indexEquipment(string teamId)

Get a list of all valid equipment icons for a team

Function: GroupHeaderContentService.indexNoticeIcons

list<NoticeIcon> indexNoticeIcons(string teamId)

Get a list of all valid notice icons for a team

Function: GroupHeaderContentService.indexCategories

list<StepGroupCategory> indexCategories(string teamId)

Get a list of all valid categories for a team

Function: GroupHeaderContentService.createCategory

StepGroupCategory createCategory(string teamId,
                                 StepGroupCategoryParams params)
    throws common.SystemException

Create a step group category for a team

Function: GroupHeaderContentService.updateCategory

StepGroupCategory updateCategory(string teamId,
                                 string categoryId,
                                 StepGroupCategoryParams params)
    throws common.SystemException

Update a step group category

Function: GroupHeaderContentService.getCategory

StepGroupCategory getCategory(string teamId,
                              string categoryId)
    throws common.SystemException

Get a step group category

Function: GroupHeaderContentService.archiveCategory

void archiveCategory(string teamId,
                     string categoryId)
    throws common.SystemException

Archive a step group category

Function: GroupHeaderContentService.unarchiveCategory

void unarchiveCategory(string teamId,
                       string categoryId)
    throws common.SystemException

Unarchive a step group category