/
REST Objects SolarVista Provider

REST Objects SolarVista Provider

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

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.    

 


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


PropertyTypeRequired?Description
HoststringYesBase URL for SolarVista API calls.
FeaturesobjectYes

An array of objects for features.


_queryCustomerApptInfo

objectYesThe  query Customer Appointment information.


Endpoint

stringYes"/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID.


ResponseOverwrite

objectYesThe predefined Object to overwrite the appointment inform



ApptSearchInfo

objectYesThe Appointment Search Informaton object.




WorkType

objectYesThe Work Type object.





Name

stringYesSpecifies the type of work for the appointment. e.g. "AL2"



Days

string

YesFormat or criteria for selecting appointment days.



Index

integerYesIndex for the starting point of appointment search.



OfferOptions

objectYesc




AllowEmpOT

booleanYesOption to allow employee overtime for appointments. e.g. true



ApptBookingInfo

objectYesContainer for appointment booking information, currently empty.









_createCustomerAppt

objectYesThe Create Customer Appointment object array.


Endpoint

stringYes"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

objectYesSimilar structure to _queryCustomerApptInfo, use the preconfigured Object to overwrite the Appointment Search response.



ApptSearchInfo

objectYesThe Appointment Search Informaton object.




WorkType

objectYesThe Work Type object.





Name

stringYesSpecifies the type of work for the appointment




Days

stringYesFormat or criteria for selecting appointment days.




Index

integerYesIndex for the starting point of appointment search.




OfferOptions

objectYesThe Work Type object.





AllowEmpOT

booleanYesOption to allow employee overtime for appointments. e.g. true



ApptBookingInfo

objectYesContainer for appointment booking information, currently empty.









_queryCustomerInfo

objectYesThe  query Customer Appointment information.


Endpoint

stringYesEndpoint for querying customer information, with placeholders for account ID and instance ID. e.g. "/ContactCentre/v2/{AccountId}/{InstanceId}/customers"

_updateCustomerApptInfo

objectYesThe object that updates Customer Appointment information.


Endpoint

stringYes"/ServiceCentre/v2/{AccountId}/{InstanceId}/jobActions/{jobActionId}" // Endpoint for updating customer appointment information, with placeholders for various IDs.

Props

objectYesThe Props array object.

AuthEndpoint

stringYes"/ServiceCentre/v2/{AccountId}/default/jobs/{jobId}/jobActions", // Endpoint for querying customer appointment information, with placeholders for account ID and job ID.

AuthClientId

stringYes"xxx-xxxx-xx-xxx-xxxx", // Client ID for OAuth2 authentication.

AuthClientSecret

stringYes"xxxxxxxxx=", // Client secret for OAuth2 authentication.

AuthGrantType

stringYes"client_credentials", // Type of grant used for OAuth2 authentication.

AuthResource

stringYes"http://live.solarvista.com/live-service", // The resource URI for OAuth2 authentication.

AccountId

stringYes"xxxxx-xxxxx-4124-a4ce-xxxxx", // Unique identifier for the account.

AccountCode

stringYes"xxxxxxxxxxxx", // Encoded account code used in API calls.

InstanceId

stringYes"default", // Instance ID, used to specify a particular instance in multi-instance setups.

customerEquipments

stringYes"/ContactCentre/v2/{AccountId}/default/customers/{customerId}/equipment", // Endpoint for querying customer equipment, with placeholders for account ID and customer ID.

problemCodes

stringYes"/ServiceCentre/v2/{AccountId}/default/jobs/{equipmentClassID}/relatedproblems" // Endpoint for querying problem codes related to a specific class of equipment.

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