REST Objects SolarVista Provider

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

{
    "Host": "https://api-hub-live.solarvista.com",
    "Features": {
        "_queryCustomerApptInfo": {
            "Endpoint": "/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions",
            "ResponseOverwrite": {
                "ApptSearchInfo": {
                    "WorkType": {
                        "Name": "AL2"
                    },
                    "Days": "YYYYYYY",
                    "Index": 0,
                    "OfferOptions": {
                        "AllowEmpOT": true
                    }
                },
                "ApptBookingInfo": {}
            }
        },
        "_createCustomerAppt": {
            "Endpoint": "",
            "ResponseOverwrite": {
                "ApptSearchInfo": {
                    "WorkType": {
                        "Name": "AL2"
                    },
                    "Days": "YYYYYYY",
                    "Index": 0,
                    "OfferOptions": {
                        "AllowEmpOT": true
                    }
                },
                "ApptBookingInfo": {}
            }
        },
        "_queryCustomerInfo": {
            "Endpoint": "/ContactCentre/v2/{AccountId}/{InstanceId}/customers"
        },
        "_updateCustomerApptInfo": {
            "Endpoint": "/ServiceCentre/v2/{AccountId}/{InstanceId}/jobActions/{jobActionId}"
        }
    },
    "Props": {
        "AuthEndpoint": "https://login.windows.net/live.solarvista.com/oauth2/token",
        "AuthClientId": "",
        "AuthClientSecret": "",
        "AuthGrantType": "client_credentials",
        "AuthResource": "http://live.solarvista.com/live-service",
        "AccountId": "",
        "AccountCode": "",
        "InstanceId": "default",
        "customerEquipments": "/ContactCentre/v2/{AccountId}/default/customers/{customerId}/equipment",
        "problemCodes": "/ServiceCentre/v2/{AccountId}/default/jobs/{equipmentClassID}/relatedproblems"
    }
}

SolarVista Provider Object Properties

Property						Type	Required?	Description
`Host`						`string`	Yes	TBC
`Features`						`object`	Yes	TBC
	`_queryCustomerApptInfo`					`object`	Yes	TBC
		`Endpoint`				`string`	Yes	TBC
		`ResponseOverwrite`				`object`	Yes	TBC
			`ApptSearchInfo`			`object`	Yes	TBC
				`WorkType`		`object`	Yes	TBC
					`Name`	`string`	Yes	TBC
			`Days`			`string`	Yes	TBC
			`Index`			`integer`	Yes	TBC
			`OfferOptions`			`object`	Yes	TBC
				`AllowEmpOT`		`boolean`	Yes	TBC
			`ApptBookingInfo`			`object`	Yes	TBC
								TBC
	`_createCustomerAppt`					`object`	Yes	TBC
		`Endpoint`				`string`	Yes	TBC
		`ResponseOverwrite`				`object`	Yes	TBC
			`ApptSearchInfo`			`object`	Yes	TBC
				`WorkType`		`object`	Yes	TBC
					`Name`	`string`	Yes	TBC
				`Days`		`string`	Yes	TBC
				`Index`		`integer`	Yes	TBC
				`OfferOptions`		`object`	Yes	TBC
					`AllowEmpOT`	`boolean`	Yes	TBC
			`ApptBookingInfo`			`object`	Yes	TBC
								TBC
	`_queryCustomerInfo`					`object`	Yes	TBC
		`Endpoint`				`string`	Yes	TBC
	`_updateCustomerApptInfo`					`object`	Yes	TBC
		`Endpoint`				`string`	Yes	TBC
`Props`						`object`	Yes	TBC
	`AuthEndpoint`					`string`	Yes	TBC
	`AuthClientId`					`string`	Yes	TBC
	`AuthClientSecret`					`string`	Yes	TBC
	`AuthGrantType`					`string`	Yes	TBC
	`AuthResource`					`string`	Yes	TBC
	`AccountId`					`string`	Yes	TBC
	`AccountCode`					`string`	Yes	TBC
	`InstanceId`					`string`	Yes	TBC
	`customerEquipments`					`string`	Yes	TBC
	`problemCodes`					`string`	Yes	TBC