Content Comparison

Info

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

Configuration > Providers > SolarVista Provider

A SolarVista 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 a SolarVista CRM for the relevant tenant.

Panel

borderColor	grey
bgColor	whitesmoke

On this page:

Table of Contents

maxLevel	3

Related pages:

SolarVista Provider Object Format

Include Page

	unknown page (AC1B2805017C4895924997295675665F)
	unknown page (AC1B2805017C4895924997295675665F)

SolarVista Provider Object Properties

TBCTBCTBCTBCTBC

Property						Type	Required?	Description
`Host`						`string`	Yes	TBCBase URL for SolarVista API calls.
`Features`						`object`	Yes	TBC
	`_queryCustomerApptInfo`					`object`	Yes	TBC
		`Endpoint`				`string`	Yes	TBC"/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID.
		`ResponseOverwrite`				`object`	Yes	TBCThe predefined Object to overwrite the appointment inform
			`ApptSearchInfo`			`object`	Yes	TBC
				`WorkType`		`object`	Yes
					`Name`	`string`	Yes	TBCSpecifies the type of work for the appointment. e.g. "AL2"
			`Days`			`string`	Yes	TBCFormat or criteria for selecting appointment days.
			`Index`			`integer`	Yes	TBCIndex for the starting point of appointment search.
			`OfferOptions`			`object`	Yes
				`AllowEmpOT`		`boolean`	Yes	TBCOption to allow employee overtime for appointments. e.g. true
			`ApptBookingInfo`			`object`	Yes	TBC	TBCContainer for appointment booking information, currently empty.

	`_createCustomerAppt`					`object`	Yes	TBC
		`Endpoint`				`string`	Yes	TBC"https://sv-servicepowerintegration-fn-westeu-prod.azurewebsites.net/api/{AccountId}/createjob?code={AccountCode}", // Endpoint for creating a customer appointment, includes placeholders for account ID and account code.
		`ResponseOverwrite`				`object`	Yes	TBCSimilar structure to _queryCustomerApptInfo, use the preconfigured Object to overwrite the Appointment Search response.
			`ApptSearchInfo`			`object`	Yes
				`WorkType`		`object`	Yes	TBC
					`Name`	`string`	Yes	TBCSpecifies the type of work for the appointment
				`Days`		`string`	Yes	TBCFormat or criteria for selecting appointment days.
				`Index`		`integer`	Yes	TBCIndex for the starting point of appointment search.
				`OfferOptions`		`object`	Yes	TBC
					`AllowEmpOT`	`boolean`	Yes	TBCOption to allow employee overtime for appointments. e.g. true
			`ApptBookingInfo`			`object`	Yes	TBC	TBC	Container for appointment booking information, currently empty.

	`_queryCustomerInfo`					`object`	Yes
		`Endpoint`				`string`	Yes	TBCEndpoint for querying customer information, with placeholders for account ID and instance ID. e.g. "/ContactCentre/v2/{AccountId}/{InstanceId}/customers"
	`_updateCustomerApptInfo`					`object`	Yes
		`Endpoint`				`string`	Yes	TBC"/ServiceCentre/v2/{AccountId}/{InstanceId}/jobActions/{jobActionId}" // Endpoint for updating customer appointment information, with placeholders for various IDs.
`Props`						`object`	Yes	TBC
	`AuthEndpoint`					`string`	Yes	TBC"/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID.
	`AuthClientId`					`string`	Yes	TBC"xxx-xxxx-xx-xxx-xxxx", // Client ID for OAuth2 authentication.
	`AuthClientSecret`					`string`	Yes	TBC"xxxxxxxxx=", // Client secret for OAuth2 authentication.
	`AuthGrantType`					`string`	Yes	TBC"client_credentials", // Type of grant used for OAuth2 authentication.
	`AuthResource`					`string`	Yes	TBC"http://live.solarvista.com/live-service", // The resource URI for OAuth2 authentication.
	`AccountId`					`string`	Yes	TBC"xxxxx-xxxxx-4124-a4ce-xxxxx", // Unique identifier for the account.
	`AccountCode`					`string`	Yes	TBC"xxxxxxxxxxxx", // Encoded account code used in API calls.
	`InstanceId`					`string`	Yes	TBC"default", // Instance ID, used to specify a particular instance in multi-instance setups.
	`customerEquipments`					`string`	Yes	TBC"/ContactCentre/v2/{AccountId}/default/customers/{customerId}/equipment", // Endpoint for querying customer equipment, with placeholders for account ID and customer ID.
	`problemCodes`					`string`	Yes	TBC"/ServiceCentre/v2/{AccountId}/default/jobs/{equipmentClassID}/relatedproblems" // Endpoint for querying problem codes related to a specific class of equipment.

Version	Old Version 4	New Version 5
Changes made by	Jason Andrew	Juanyong Zhang
Saved on	Nov 09, 2023	Feb 23, 2024

Versions Compared

Key

SolarVista Provider Object Format

SolarVista Provider Object Properties