/
REST Objects SolarVista Provider
REST Objects SolarVista Provider
SolarVista Provider Object Format
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. | |||||
| object | Yes | The query Customer Appointment information. | |||||
| string | Yes | "/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID. | |||||
| object | Yes | The predefined Object to overwrite the appointment inform | |||||
| object | Yes | The Appointment Search Informaton object. | |||||
| object | Yes | The Work Type object. | |||||
| string | Yes | Specifies the type of work for the appointment. e.g. "AL2" | |||||
|
| Yes | Format or criteria for selecting appointment days. | |||||
| integer | Yes | Index for the starting point of appointment search. | |||||
| object | Yes | c | |||||
| boolean | Yes | Option to allow employee overtime for appointments. e.g. true | |||||
| object | Yes | Container for appointment booking information, currently empty. | |||||
| object | Yes | The Create Customer Appointment object array. | |||||
| 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. | |||||
| object | Yes | Similar structure to _queryCustomerApptInfo, use the preconfigured Object to overwrite the Appointment Search response. | |||||
| object | Yes | The Appointment Search Informaton object. | |||||
| object | Yes | The Work Type object. | |||||
| string | Yes | Specifies the type of work for the appointment | |||||
| string | Yes | Format or criteria for selecting appointment days. | |||||
| integer | Yes | Index for the starting point of appointment search. | |||||
| object | Yes | The Work Type object. | |||||
| boolean | Yes | Option to allow employee overtime for appointments. e.g. true | |||||
| object | Yes | Container for appointment booking information, currently empty. | |||||
| object | Yes | The query Customer Appointment information. | |||||
| string | Yes | Endpoint for querying customer information, with placeholders for account ID and instance ID. e.g. "/ContactCentre/v2/{AccountId}/{InstanceId}/customers" | |||||
| object | Yes | The object that updates Customer Appointment information. | |||||
| string | Yes | "/ServiceCentre/v2/{AccountId}/{InstanceId}/jobActions/{jobActionId}" // Endpoint for updating customer appointment information, with placeholders for various IDs. | |||||
| object | Yes | The Props array object. | |||||
| string | Yes | "/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID. | |||||
| string | Yes | "xxx-xxxx-xx-xxx-xxxx", // Client ID for OAuth2 authentication. | |||||
| string | Yes | "xxxxxxxxx=", // Client secret for OAuth2 authentication. | |||||
| string | Yes | "client_credentials", // Type of grant used for OAuth2 authentication. | |||||
| string | Yes | "http://live.solarvista.com/live-service", // The resource URI for OAuth2 authentication. | |||||
| string | Yes | "xxxxx-xxxxx-4124-a4ce-xxxxx", // Unique identifier for the account. | |||||
| string | Yes | "xxxxxxxxxxxx", // Encoded account code used in API calls. | |||||
| string | Yes | "default", // Instance ID, used to specify a particular instance in multi-instance setups. | |||||
| string | Yes | "/ContactCentre/v2/{AccountId}/default/customers/{customerId}/equipment", // Endpoint for querying customer equipment, with placeholders for account ID and customer ID. | |||||
| string | Yes | "/ServiceCentre/v2/{AccountId}/default/jobs/{equipmentClassID}/relatedproblems" // Endpoint for querying problem codes related to a specific class of equipment. |
, multiple selections available,
Related content
_Providers Object Format
_Providers Object Format
More like this
REST Objects Appointment Offer
REST Objects Appointment Offer
More like this
REST Objects Modules
REST Objects Modules
More like this
REST Objects Appointment Search
REST Objects Appointment Search
More like this
REST Objects Tenant
REST Objects Tenant
More like this