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.

On this page:

Related pages:

SolarVista Provider Object Format

JSON Format

{
    "SolarVista": {
        "Host": "https://api-hub-live.solarvista.com", // Base URL for SolarVista API calls.
        "Features": {
            "_queryCustomerApptInfo": {
                "Endpoint": "/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID.
                "ResponseOverwrite": {
                    "ApptSearchInfo": {
                        "WorkType": {
                            "Name": "AL2" // Specifies the type of work for the appointment.
                        },
                        "Days": "YYYYYYY", // Format or criteria for selecting appointment days.
                        "Index": 0, // Index for the starting point of appointment search.
                        "OfferOptions": {
                            "AllowEmpOT": true // Option to allow employee overtime for appointments.
                        }
                    },
                    "ApptBookingInfo": {} // Container for appointment booking information, currently empty.
                }
            },
            "_createCustomerAppt": {
                "Endpoint": "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": {
                    // Similar structure to _queryCustomerApptInfo, used for creating appointments.
                }
            },
            "queryCustomerInfo": {
                "Endpoint": "/ContactCentre/v2/{AccountId}/{InstanceId}/customers" // Endpoint for querying customer information, with placeholders for account ID and instance ID.
            },
            "_updateCustomerApptInfo": {
                "Endpoint": "/ServiceCentre/v2/{AccountId}/{InstanceId}/jobActions/{jobActionId}" // Endpoint for updating customer appointment information, with placeholders for various IDs.
            }
        },
        "Props": {
            "AuthEndpoint": "https://login.windows.net/live.solarvista.com/oauth2/token", // Authentication endpoint for obtaining OAuth2 tokens.
            "AuthClientId": "a237d059-xxxx-xxxx-b6ca-xxxxx", // Client ID for OAuth2 authentication.
            "AuthClientSecret": "xxxxxx+6IZn7sPT/xxxx=", // Client secret for OAuth2 authentication.
            "AuthGrantType": "client_credentials", // Type of grant used for OAuth2 authentication.
            "AuthResource": "http://live.solarvista.com/live-service", // The resource URI for OAuth2 authentication.
            "AccountId": "6708189d-xxxx-xxxx-a4ce-xxxxx", // Unique identifier for the account.
            "AccountCode": "D0Qb%xxxxx%xxxxxxxx%3D%3D", // Encoded account code used in API calls.
            "InstanceId": "default", // Instance ID, used to specify a particular instance in multi-instance setups.
            "customerEquipments": "/ContactCentre/v2/{AccountId}/default/customers/{customerId}/equipment", // Endpoint for querying customer equipment, with placeholders for account ID and customer ID.
            "problemCodes": "/ServiceCentre/v2/{AccountId}/default/jobs/{equipmentClassID}/relatedproblems" // Endpoint for querying problem codes related to a specific class of equipment.
        }
    }
}

SolarVista Provider Object Properties

Property						Type	Required?	Description
`Host`						`string`	Yes	Base URL for SolarVista API calls.
`Features`						`object`	Yes	An array of objects for features.
	`_queryCustomerApptInfo`					`object`	Yes	The query Customer Appointment information.
		`Endpoint`				`string`	Yes	"/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID.
		`ResponseOverwrite`				`object`	Yes	The predefined Object to overwrite the appointment inform
			`ApptSearchInfo`			`object`	Yes	The Appointment Search Informaton object.
				`WorkType`		`object`	Yes	The Work Type object.
					`Name`	`string`	Yes	Specifies the type of work for the appointment. e.g. "AL2"
			`Days`			`string`	Yes	Format or criteria for selecting appointment days.
			`Index`			`integer`	Yes	Index for the starting point of appointment search.
			`OfferOptions`			`object`	Yes	c
				`AllowEmpOT`		`boolean`	Yes	Option to allow employee overtime for appointments. e.g. true
			`ApptBookingInfo`			`object`	Yes	Container for appointment booking information, currently empty.

	`_createCustomerAppt`					`object`	Yes	The Create Customer Appointment object array.
		`Endpoint`				`string`	Yes	"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	Similar structure to _queryCustomerApptInfo, use the preconfigured Object to overwrite the Appointment Search response.
			`ApptSearchInfo`			`object`	Yes	The Appointment Search Informaton object.
				`WorkType`		`object`	Yes	The Work Type object.
					`Name`	`string`	Yes	Specifies the type of work for the appointment
				`Days`		`string`	Yes	Format or criteria for selecting appointment days.
				`Index`		`integer`	Yes	Index for the starting point of appointment search.
				`OfferOptions`		`object`	Yes	The Work Type object.
					`AllowEmpOT`	`boolean`	Yes	Option to allow employee overtime for appointments. e.g. true
			`ApptBookingInfo`			`object`	Yes	Container for appointment booking information, currently empty.

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

Browser not supported