REST Objects Modules

Modules Object Format

JSON Format

{
	"ApptSearch": {
		// ApptSearch Object
	},
	"ApptBook": {
		// ApptBook Object
	},
	"BNS": {
		// BNS Object
	},
	"Gantt": {
		// Gantt Object
	},
	"Hybrid": {
		// Hybrid Object
	},
	"SysType": {
		// SysType Object
	},
	"WorkItem": {
		// WorkItem Object
	},
	"Telematics": {
		// Telematics Object
	}
}

Modules Object Properties

Property	Type	Required?	Description
`ApptSearch`	`object`	Yes	An ApptSearch object representing how ServiceBroker should search for appointment offerings from the configured Providers, for the relevant tenant.
`ApptBook`	`object`	Yes	An ApptBook object representing how ServiceBroker should handle the booking of appointments through the configured Providers, for the relevant tenant.
`BNS`	`object`	Yes	A BNS object representing how the ServiceBroker Notification Service is configured, for the relevant tenant.
`Gantt`	`object`	Yes	A Gantt object representing the primary sub-system to use for Work Item information when ServiceBroker is being used as the backend system for ServicePower's Next Generation Gantt (NGG), for the relevant tenant.
`Hybrid`	`object`	Yes	A Hybrid object. Purpose of the object TBC.
`SysType`	`object`	Yes	A SysType object representing non-transactional master data sets required for integration with configured Providers, for the relevant tenant.
`WorkItem`	`object`	Yes	A WorkItem object representing how ServiceBroker's WorkItem module is configured - which controls a number of Work Item related activities - for the relevant tenant.
`Telematics`	`object`	Yes	A Telematics object representing if a Telematics (GPS) system is configured or not, for the relevant tenant.

ServiceBroker 5

REST Objects Modules

Analytics

Modules Object Format

Modules Object Properties

Related content