ServiceV2

Integration Guide
Version Date Author Description
1.0 12-12-2018 Kieran Delahunt (Contact Online) Initial draft

Service locations

URL Environment
Service https://tools.contactonline.co.uk/ServiceV2.asmx
https://staging.tools.contactonline.co.uk/ServiceV2.asmx
Live
Staging
WSDL https://tools.contactonline.co.uk/ExternalLMSService.asmx?WSDL
https://staging.tools.contactonline.co.uk/ExternalLMSService.asmx?WSDL
Live
Staging

Version

Currently 1.0


Methods

1. AdministerContact

Allows the user to create a lead in the Contact Online system

Request

Method AdministerContact
Action /IntegrationServiceV2/CreateLeadAndActivity
Params Values Required Description
UserName string False  
Password string False
CID int True  
IntegrationCode string False  
Title string False  
Firstname string False  
Lastname string False  
Email string False  
Address1 string False  
Address2 string False  
Address3 string False  
City string False  
Postcode string False  
County string False  
Country string False  
Mobile string False  
Home string False  
Work string False  
PreferredContactMethod int True  
OptInCall boolean True  
OptInEmail boolean True  
OptInSms boolean True  
OptInPost boolean True  
DOB string False  
PeronalNotes string False  
SourceOfEnquiry string False  

Response

Parameter Value
AdministerContactResult int

2. AdministerDiaryEntry

Allows the user to create a diary entry for a lead in the Contact Online system

Request

Method AdministerDiaryEntry
Action /IntegrationServiceV2/AdministerDiaryEntry
Params Values Required Description
UserName string False  
Password string False
CID int True  
IntegrationCode string False  
InterestProductID int True  
InterestMakeID int True  
InterestModelID int True  
InterestDetail string False  
InterestIsNew boolean True  
InterestIsMotability boolean True  
PxProductID int True  
PxMakeID int True  
PxModelID int True  
PxYear int True  
PxMonth int True  
PxRegistration string False  
PxDetail string False  
DiaryNotes string False  

Response

Parameter Value
AdministerDiaryEntryResponse int

2. AdministerDiaryEntryWebLeadOnly

Allows the user to create a lead in the Contact Online system from the web source only

Request

Method AdministerDiaryEntryWebLeadOnly
Action /IntegrationServiceV2/AdministerDiaryEntryWebLeadOnly
Params Values Required Description
UserName string False  
Password string False
CID int True  
IntegrationCode string False  
InterestProductID int True  
InterestMakeID int True  
InterestModelID int True  
InterestDetail string False  
InterestIsNew boolean True  
InterestIsMotability boolean True  
PxProductID int True  
PxMakeID int True  
PxModelID int True  
PxYear int True  
PxMonth int True  
PxRegistration string False  
PxDetail string False  
DiaryNotes string False  

Response

Parameter Value
AdministerDiaryEntryWebLeadOnlyResult int

4. GetCCC

Allows the user to get the CCC Contact Online system

Request

Method GetCCC
Action /IntegrationServiceV2/GetCCC
Params Values Required Description
UserName string False  
Password string False
ContactID int True  
SalesPersonID int True  

Response

Parameter Value
GetCCCResponse int

5. ListAvailableDealershipsJSON

Allows the user to get dealerships within the Contact Online system

Request

Method ListAvailableDealershipsJSON
Action /IntegrationServiceV2/ListAvailableDealershipsJSON
Params Values Required Description
UserName string False  
Password string False
ModelID int True  
TagID int True  

Response

Parameter Value
ListAvailableDealershipsJSONResult JSON string

6. ListAvailableDealershipsXML

Allows the user to get dealerships within the Contact Online system

Request

Method ListAvailableDealershipsXML
Action /IntegrationServiceV2/ListAvailableDealershipsXML
Params Values Required Description
UserName string False  
Password string False
ModelID int True  
TagID int True  

Response

Parameter Value
ListAvailableDealershipsXMLResult XML string

7. ListModelIDsJSON

Allows the user to get models within the Contact Online system

Request

Method ListModelIDsJSON
Action /IntegrationServiceV2/ListModelIDsJSON
Params Values Required Description
UserName string False  
Password string False
Tag1 string False  
Tag2 string False  

Response

Parameter Value
ListModelIDsJSONResult JSON string

8. ListModelIDsXML

Allows the user to get models within the Contact Online system

Request

Method ListModelIDsXML
Action /IntegrationServiceV2/ListModelIDsXML
Params Values Required Description
UserName string False  
Password string False
Tag1 string False  
Tag2 string False  

Response

Parameter Value
ListModelIDsXMLResult XML string

9. ListSourceOfEnquiryJSON

Allows the user to get source of enquiry list within the Contact Online system

Request

Method ListSourceOfEnquiryJSON
Action /IntegrationServiceV2/ListSourceOfEnquiryJSON
Params Values Required Description
UserName string False  
Password string False

Response

Parameter Value
ListSourceOfEnquiryJSONResult JSON string

10. ListSourceOfEnquiryXML

Allows the user to get source of enquiry list within the Contact Online system

Request

Method ListSourceOfEnquiryXML
Action /IntegrationServiceV2/ListSourceOfEnquiryXML
Params Values Required Description
UserName string False  
Password string False

Response

Parameter Value
ListSourceOfEnquiryXMLResult XML string

11. SaveCCCResponse

Allows the user to get save a CC response within the Contact Online system

Request

Method SaveCCCResponse
Action /IntegrationServiceV2/SaveCCCResponse
Params Values Required Description
UserName string False  
Password string False
ContactID int True
SalesPersonID int True
CustomerResponse boolean True
CustomerComments string False

Response

Parameter Value
SaveCCCResponse SaveCCCResponse object