REST Objects ServiceGPS Provider

5.0.0

The ServiceGPS Provider object is part of the overall ServiceBroker Configuration object, in the following location:

Configuration > Providers > ServiceGPS Provider

A ServiceGPS Provider object is used within the context of a REST Objects Providers (itself part of an REST Objects Configuration) to represent the details of how ServiceBroker is to be integrated with ServiceGPS for the relevant tenant.

On this page:

Related pages:

ServiceGPS Provider Object Format

JSON Format

{
	"Enabled": true,
	"User": "",
	"Password": "",
	"Company": "",
	"IdType": ""
}

ServiceGPS Provider Object Properties

Property	Type	Required?	Description
`Enabled`	`boolean`	Yes	Should integration with ServiceGPS be used?
`User`	`string`	No	The username to use to connect to ServiceGPS. Required when `Enabled` is `true`.
`Password`	`string`	No	The password to use to connect to ServiceGPS. Required when `Enabled` is `true`.
`Company`	`string`	No	The ServiceGPS tenant (account) to connect to. Required when `Enabled` is `true`.
`IdType`	`string`	No	Either `Driver` or `Vehicle`, representing the type of GPS device used by the `Company` (i.e. mobile GPS device carried by the worker, or a GPS device attached to the worker's vehicle). Required when `Enabled` is `true`.