Indicator

The video below showcases the functionality of some of the indicators:

Category

A category is the property or attribute of an appointment that determines the color in which an appointment is displayed. The category is used to provide an immediate visual insight in the type or status of appointments.

Upsert

Inserts or updates a category record.

Name	Data Type	Default	Required
CategoryName	nvarchar(100)		✔️
DisplayName	nvarchar(100)	CategoryName
CategoryHexColor	nvarchar(50)
ColorR	int
ColorG	int
ColorB	int

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertCategory.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertCategory",
          "ParameterNames": ["CategoryName", "DisplayName", "CategoryHexColor"],
          "ParameterValues": ["INPROGRESS", "In Progress", "#6e64b5"]
      }
  ]

API

See POST /category, PUT /category in the REST API reference.

Rename category

Renames the category.

Name	Data Type	Default	Required
CategoryName	nvarchar(100)		✔️
NewCategoryName	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renameCategory.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renameCategory",
          "ParameterNames": ["CategoryName", "NewCategoryName"],
          "ParameterValues": ["INPROCESSTYPO", "INPROCESS"]
      }
  ]

API

This endpoint is not available yet.

Delete category

Removes this indicator from the database.

Name	Data Type	Default	Required
CategoryName	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteCategory.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteCategory",
          "ParameterNames": ["CategoryName"],
          "ParameterValues": ["INPROCESS"]
      }
  ]

API

See DELETE /category in the REST API reference.

Time Marker

A time marker is the property or attribute of an appointment that determines the colored bar displayed below the appointment in the planning board. The time marker is used to provide an immediate visual insight in the type or status of appointments.

Upsert time marker

Inserts or updates a time marker record.

Name	Data Type	Default	Required
TimeMarker	nvarchar(100)		✔️
HexColor	nvarchar(50)
ColorR	int
ColorG	int
ColorB	int

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertTimeMarker.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertTimeMarker",
          "ParameterNames": ["TimeMarker", "HexColor"],
          "ParameterValues": ["In Progress", "#6e64b5"]
      }
  ]

API

See POST /timeMarker, PUT /timeMarker in the REST API reference.

Rename time marker

Renames the time marker.

Name	Data Type	Default	Required
TimeMarker	nvarchar(100)		✔️
NewTimeMarker	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renameTimeMarker.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renameTimeMarker",
          "ParameterNames": ["TimeMarker", "NewTimeMarker"],
          "ParameterValues": ["INPROCESSTYPO", "INPROCESS"]
      }
  ]

API

This endpoint is not available yet.

Delete time marker

Removes this indicator from the database.

Name	Data Type	Default	Required
TimeMarker	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteTimeMarker.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteTimeMarker",
          "ParameterNames": ["TimeMarker"],
          "ParameterValues": ["INPROCESS"]
      }
  ]

API

See DELETE /timeMarker in the REST API reference.

Pin

A pin is the property or attribute of an appointment that determines the colored pin on the map.

Upsert pin

Inserts or updates a pin record.

Name	Data Type	Default	Required
Name	nvarchar(100)		✔️
HexColor	nvarchar(50)
ColorR	int
ColorG	int
ColorB	int

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertPin.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertPin",
          "ParameterNames": ["Name", "HexColor"],
          "ParameterValues": ["In Progress", "#6e64b5"]
      }
  ]

API

See POST /pin, PUT /pin in the REST API reference.

Rename pin

Renames the pin.

Name	Data Type	Default	Required
Name	nvarchar(100)		✔️
NewName	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renamePin.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renamePin",
          "ParameterNames": ["Name", "NewName"],
          "ParameterValues": ["INPROCESSTYPO", "INPROCESS"]
      }
  ]

API

This endpoint is not available yet.

Delete pin

Removes the indicator from the database.

Name	Data Type	Default	Required
Name	nvarchar(30)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deletePin.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deletePin",
          "ParameterNames": ["Name"],
          "ParameterValues": ["INPROCESS"]
      }
  ]

API

See DELETE /pin in the REST API reference.