Lead Forensics Integration Web API - Parameters Controller
GetParameterData
Input Parameters
- clientuserid (int) - Represents the Client User identifier to be passed to the method.
- clientcrmversionid (int) - Represents the Client CRM Version identifier to be passed to the method.
- clientid (int) - Represents the Client identifier to be passed to the method.
- visitid (Int64) - Represents the Visit identifier to be passed to the method.
- alldata (int) - Deprecated - legacy
- searchresult (int) - Controls 'Search Enabled' output
- triggerreportid (int) - Identifier for the trigger reportID that this visit matched
Output
- $id (int) - The row number of the record returned.
- ServiceURL (int) - The service endpoint of the CRM
- Assembly (string) - The name of the assembly used
- Class (string) - The class used
- User (string) - The user name used for the crm connection
- Password (string) - The password used for the crm connection
- VisitXML (string) - The raw XML containing the visit information
- Domain (string) - The domain to connect to at the crm
- Instance (string) - The instance name of the crm to connect to
- InterfaceVersion (int) - The interface version to use with the integration service
- CreateLead (int) - Determines if a lead should be created (0 = no leads created, 1 = create leads)
Example URL
http://localhost:61028/integrationapi_v1/Parameters/GetParameterData?clientcrmversionid=755&clientuserid=61178&clientid=30011&visitid=387884170&alldata=0&searchresult=&triggerreportid=1
GetClientCRMParameters
Input Parameters
- clientuserid (int) - Represents the Client User identifier to be passed to the method.
- clientcrmversionid (int) - Represents the Client CRM Version identifier to be passed to the method.
Output
- $id (int) - The row number of the record returned.
- ClientID - The unique client identifier
- ClientUserID - The unique client user identifier
- ClientCrmVersionID - The unique client crm version identifier
- CRMID - The unique identifier for the CRM instance
- CustomID1 - The first custom field contents
- CustomID2 - The second custom field contents
- CustomID3 - The third custom field contents
- CustomID4 - The fourth custom field contents
- CustomID5 - The fifth custom field contents
- CustomID6 - The sixth custom field contents
- CustomID7 - The seventh custom field contents
- CustomID8 - The eighth custom field contents
- WeeklyImportsEmail - The email to send the Salesforce Lite notification to
- AutoPost - If the visits are posted automatically
- InterfaceVersion - The version of the integration service interface to use
- UsesIntegrationService - If the integration is uses the integration service ( 0 = no integration service, 1 = uses integration service)
- AutomaticIntegration - If the customer integration is automatically delivered
- CRMName - The name of the CRM which is integrated with
- oAuthKey - Our authorisation key to connect to Salesforce with
- oAuthSecret - Our secret key to connect to Salesforce with
- oAuthEnabled - Detemines if open authentication is enabled for the integration (0 = no open authentication, 1 = does support oAuth)
- NotificationEmail - The email address to send notifications to (not currently used)
- ImageURL - The image displayed in the portal for the integration
- AllowAddDefaultMappings - Determines if the default mappings button should be displayed in the portal (0 = button not shown, 1 = button shown)
- ShowAdvanced - Determines if the advanced options should be displayed on the integration settings page (0 = hide, 1 = show)
Example URL
http://localhost:61028/integrationapi_v1/Parameters/GetClientCRMParameters?clientcrmversionid=755&clientuserid=61178
GetClientPropertyBag
Input Parameters
- clientuserid (int) - Represents the Client User identifier to be passed to the method.
Output
- $id (int) - The row number of the record returned.
- ClientCRMParameterID (int) - The Client CRM Parameter identifier
- Name (string) - The name of the parameter
- Value (string) - The value of the parameter
- Display (int) - If the field should be shown (0 = no, 1 = yes)
- ReadOnly (int) - f the field is read only (0 = no, 1 = yes)
- PasswordField (int) - If the field is a password field (0 = no, 1 = yes)
- HelpText (string) - The text to display as help
- DefaultValue (string) - The default value to apply to the parameter
- ClientID (int) - [Use oAuth only] The Client Identifier
- ClientUserID (string) - [Use oAuth only] The Client User Identifier
- ButtonText (string) - [Use oAuth only] The text for the button link to the oAuth Service
Example URL
http://localhost:61028/integrationapi_v1/Parameters/GetClientPropertyBag?clientuserid=1
UpsertClientCRMParameters
Input Parameters
- clientcrmversionid (int) - Represents the ClientCRMVersion identifier to be passed to the method.
- clientuserid (int) - Represents the Client User identifier to be passed to the method.
- xml (string) - The XML string containing the visit connection details
Output
GetNewClientCRMParameters
Input Parameters
- clientcrmversionid (int) - Represents the ClientCRMVersion identifier to be passed to the method.
- clientuserid (int) - Represents the Client User identifier to be passed to the method.
Output
- $id (int) - The row number of the record returned.
- ClientCRMParameterID (int) - This is actually the Client CRM Parameter Option identifier
- Name (string) - The name of the parameter
- Value (string) - The value of the parameter
- Display (int) - If the field should be shown (0 = no, 1 = yes)
- ReadOnly (int) - f the field is read only (0 = no, 1 = yes)
- PasswordField (int) - If the field is a password field (0 = no, 1 = yes)
- HelpText (string) - The text to display as help
- DefaultValue (string) - The default value to apply to the parameter
- ClientID (int) - [Use oAuth only] The Client Identifier
- ClientUserID (string) - [Use oAuth only] The Client User Identifier
- ButtonText (string) - [Use oAuth only] The text for the button link to the oAuth Service
Example URL
http://localhost:61028/integrationapi_v1/Parameters/GetNewClientCRMParameters?clientcrmversionid=805