Appointment

The appointment entity is what Dime.Scheduler is all about. An appointment is the main deliverable of the software and represents a block in the planning board. The appointment contains the information of the appointment such as the start and end date, and it holds references to the resources that have been assigned to it.

The following entities are exposed through the API.

Appointment

Upsert appointment

Inserts or updates an appointment record. The behavior of this procedure depends on the data you pass to it:

• The appointment id is required if you want to update an existing appointment.
• Otherwise, it inserts an appointment resource record (linking a resource to the appointment) if the record does not exist.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)		✔️	See API reference
SourceType	nvarchar(10)		✔️	See API reference
JobNo	nvarchar(50)		✔️
TaskNo	nvarchar(50)		✔️
AppointmentNo	nvarchar(max)	0
AppointmentId	bigint	0
Subject	nvarchar(max)
Body	nvarchar(max)
Start	datetime			Use ISO 8601 format: yyyy-mm-ddThh:mm
End	datetime			Use ISO 8601 format: yyyy-mm-ddThh:mm
IsAllDayEvent	bit	0		This field is deprecated.
Category	nvarchar(100)			See API reference
TimeMarker	nvarchar(100)			See API reference
Importance	int	0		See API reference
Locked	bit	0
ResourceNo	nvarchar(50)
AppointmentGuid	nvarchar(50)
ReplaceResource	bit	0
SentFromBackoffice	bit	1
BackofficeID	nvarchar(100)
BackofficeParentID	nvarchar(100)
PlanningUOM	nvarchar(20)
PlanningUOMConversion	decimal(18,6)	0
PlanningQty	decimal(18,6)	0
UseFixPlanningQty	bit	0
RoundToUOM	bit	0

Import

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

  [
      {
          "StoredProcedureName": "mboc_upsertAppointment",
          "ParameterNames": ["SourceApp", "SourceType", "JobNo", "TaskNo", "Subject", "Start", "End"],
          "ParameterValues": ["BCCOMPANY1", "JOB", "JOB001", "TASK001", "Important meeting", "2024-01-01T15:00","2024-01-02T15:00"]
      }
  ]

API

• Endpoint: /appointment
• Supported HTTP methods: POST (create) and PUT (update)
• Example body:

  {      
    "SourceApp": "BCCOMPANY1",
    "SourceType": "JOB",
    "JobNo": "JOB001",
    "TaskNo": "TASK001",
    "AppointmentNo": "xj0rJJb3",
    "Start": "2024-01-01T15:00",
    "End": "2024-01-02T15:00",
    "Subject": "Important meeting"  
  }

Delete appointment

The behavior of this procedure depends on the data you pass to it:

• If a resource number is provided, then the appointment resource record is deleted. The appointment record is also deleted if no more appointment resource records exist for the appointment.
• If the resource number is not provided, then the appointment record and all linked appointment resource records are deleted.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)		✔️	See API reference
SourceType	nvarchar(10)		✔️	See API reference
AppointmentNo	nvarchar(max)	0
AppointmentId	bigint
AppointmentGuid	nvarchar(50)
ResourceNo	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_deleteAppointment",
          "ParameterNames": ["SourceApp", "SourceType", "AppointmentNo"],
          "ParameterValues": ["BCCOMPANY1", "JOB", "x0rnJJ2b"]
      }
  ]

API

• Endpoint: /appointment
• Supported HTTP methods: DELETE

Upsert appointment URI

Inserts or updates an appointment URI record.

An appointment URI contains links to documents, web pages and the back-office system. You need to pass an existing appointment id or appointment GUID.

Name	Data Type	Default	Required	Description
pSourceApp	nvarchar(30)			See API reference
pSourceType	nvarchar(10)			See API reference
pAppointmentId	bigint	0
pAppointmentGuid	nvarchar(50)
pUrl	nvarchar(1000)		✔️
pUrlDesc	nvarchar(255)

Import

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

  [
      {
          "StoredProcedureName": "mboc_upsertAppointmentUrl",
          "ParameterNames": ["pUrl", "pAppointmentId"],
          "ParameterValues": ["https://docs.dimescheduler.com", "15123"]
      }
  ]

API

• Endpoint: /appointmentUri
• Supported HTTP methods: POST (create) and PUT (update)

Upsert appointment container

Adds or updates the allocation of an appointment to a container.

Name	Data Type	Default	Required
Container	nvarchar(100)		✔️
Appointment	nvarchar(100)		✔️

Import

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

  [
      {
          "StoredProcedureName": "mboc_upsertAppointmentContainer",
          "ParameterNames": ["Container", "Appointment"],
          "ParameterValues": ["CONTAINER001", "200"]
      }
  ]

API

• Endpoint: /appointmentContainer
• Supported HTTP methods: POST (create) and PUT (update)

Add assignment

Add a resource to an existing appointment, thereby creating a linked appointment.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint		✔️
AppointmentNo	nvarchar(max)	0
ResourceNo	nvarchar(50)		✔️
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_addAppointmentResource",
          "ParameterNames": ["AppointmentId", "ResourceNo"],
          "ParameterValues": ["100", "2"]
      }
  ]

API

• Endpoint: /assignment
• Supported HTTP methods: POST (create) and PUT (update)

Properties

Update appointment content

Updates the body and subject of the selected appointment.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint
AppointmentNo	nvarchar(max)	0
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1
Subject	nvarchar(max)
Body	nvarchar(max)

Import

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

  [
      {
          "StoredProcedureName": "mboc_updateAppointmentContent",
          "ParameterNames": ["AppointmentId", "Subject"],
          "ParameterValues": ["1", "Hello world!"]
      }
  ]

API

• Endpoint: /appointmentContent
• Supported HTTP methods: POST

Update appointment planning quantity

Updates the planning quantity of an appointment.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint
AppointmentNo	nvarchar(max)	0
PlanningQty	decimal(18,6)
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_updateAppointmentPlanningQty",
          "ParameterNames": ["AppointmentId", "PlanningQty"],
          "ParameterValues": ["1", "24"]
      }
  ]

API

• Endpoint: /appointmentPlanningQuantity
• Supported HTTP methods: POST

Indicators

Set time marker

Update the time marker assigned to the appointment. Can be used to update status or progress of the appointment.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint
AppointmentNo	nvarchar(max)	0
TimeMarker	nvarchar(100)
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_updateAppointmentTimeMarker",
          "ParameterNames": ["AppointmentId", "TimeMarker"],
          "ParameterValues": ["1", "TIMEMARKER002"]
      }
  ]

API

• Endpoint: /appointmentTimeMarker
• Supported HTTP methods: POST

Set category

Updates the category assigned to the appointment. Can be used to update status or progress of the appointment.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint
AppointmentNo	nvarchar(max)	0
Category	nvarchar(100)
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_updateAppointmentCategory",
          "ParameterNames": ["AppointmentId", "Category"],
          "ParameterValues": ["1", "CATEGORY002"]
      }
  ]

API

• Endpoint: /appointmentCategory
• Supported HTTP methods: POST

Set lock

Locks or unlocks an appointment. A locked appointment can not be modified nor deleted on the planning board.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint
AppointmentNo	nvarchar(max)	0
Locked	bit	0
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_updateAppointmentLocked",
          "ParameterNames": ["AppointmentId", "Locked"],
          "ParameterValues": ["1", "true"]
      }
  ]

API

• Endpoint: /appointmentLocked
• Supported HTTP methods: POST

Set importance

Sets the importance of an appointment.

Name	Data Type	Default	Required	Description
SourceApp	nvarchar(30)			See API reference
SourceType	nvarchar(10)			See API reference
AppointmentId	bigint
AppointmentNo	nvarchar(max)	0
Importance	int	0		See API reference
AppointmentGuid	nvarchar(50)
SentFromBackoffice	bit	1

Import

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

  [
      {
          "StoredProcedureName": "mboc_updateAppointmentImportance",
          "ParameterNames": ["AppointmentId", "Importance"],
          "ParameterValues": ["1", "2"]
      }
  ]

API

• Endpoint: /appointmentImportance
• Supported HTTP methods: POST

API reference

Source

Dime.Scheduler is a centralized planning application. One the key tenets is the ability to accommodate data from different origins. For instance, it is perfectly acceptable to plan work orders from Business Central, CRM, imported Excel sheets, etc., and Dime.Scheduler won't break a sweat because of the existence of the Source App and SourceType fields in the data model.

Source App

When the planner makes an appointment for a resource or task, Dime.Scheduler knows which system to notify. Through the connector setup, Dime.Scheduler will find a matching SourceApp and send the appointment to the corresponding URI subsequently. The source app field is a unique identifier that identifies a back office instance such a tenant of Business Central, a test environment, an instance of CRM cloud, or any other application you wish to use to feed the data into Dime.Scheduler.

Source Type

The SourceType is used inside the back-office system itself. A source type represents a distinct entity such as a service order, production order, assembly order, etc.

The standard connectors that Dime Software provides make it possible to plan different types of resources and tasks. When Dime.Scheduler posts an appointment to a standard connector, it ends up in a staging table, which is then processed by the connector to make sure the appointment produced in Dime.Scheduler is traced back to the original record using the externally identifiable fields (JobNo, TaskNo, ResourceNo) that identify the record.

Category

Controls the visual indicator of the planned task in the planning board. Read more about this topic here.

Time Marker

Controls the visual indicator of the planned task in the planning board. Read more about this topic here.