Submitting a Web Enquiry
1. Endpoint and Method
|
Detail
|
Value
|
|
Endpoint
|
https://api.autovusolutions.com/api/WebEnquiry.aspx
|
|
Method
|
POST
|
|
Content Type
|
application/x-www-form-urlencoded
|
2. Authentication
Authentication is handled via the Authorization header using Basic Auth.
|
Component
|
Description
|
|
Username
|
The API Key (cid)
|
|
Password
|
The dedicated password provided for this API
|
|
Format
|
The client tool will encode cid:password into a Base64 string for the Authorization header.
|
Important: You must use HTTPS for all connections.
3. Available Data Fields
The following parameters can be submitted in the request body (or query string). Please note the maximum lengths enforced by the API.
|
Parameter
|
Max Length
|
Mandatory?
|
Description
|
|
PersonFirstname
|
50
|
No
|
The individual's first name.
|
|
PersonLastName
|
50
|
No
|
The individual's last name.
|
|
PersonName
|
100
|
No
|
Full name. If blank, is generated from Title/First/Last Name.
|
|
PersonTitle
|
50
|
No
|
Title (e.g., Mr, Ms, Dr).
|
|
CompanyName
|
50
|
No
|
The name of the company/organisation.
|
|
EnqType
|
50
|
No
|
The category or type of enquiry.
|
|
Email
|
N/A
|
Conditional*
|
Primary email address.
|
|
Mobile
|
N/A
|
No
|
Mobile phone number.
|
|
Landline
|
N/A
|
No
|
Landline phone number.
|
|
Fax
|
N/A
|
No
|
Fax number.
|
|
Web
|
N/A
|
No
|
Website URL.
|
|
Add1
|
N/A
|
Conditional*
|
Address Line 1.
|
|
Add2
|
N/A
|
No
|
Address Line 2.
|
|
BuildingName
|
N/A
|
No
|
Building name/Sub-premise.
|
|
Town
|
N/A
|
No
|
Town/City.
|
|
County
|
N/A
|
No
|
County/State.
|
|
Postcode
|
N/A
|
Conditional*
|
Postcode/Zip Code.
|
|
Country
|
N/A
|
No
|
Country. If provided, must be in ISO 3166-1 alpha-2 format (e.g., GB).
|
|
TagName
|
N/A
|
No
|
A custom tag or source marker for the enquiry.
|
|
EnqDetails
|
N/A
|
Yes
|
REQUIRED. The main content of the enquiry. (HTML tags are stripped).
|
|
AdditionalNotes
|
N/A
|
No
|
Any extra notes to be saved with the enquiry. (HTML tags are stripped).
|
4. Validation Rules
A successful submission requires the following minimum data:
-
Authentication: Valid cid and password via Basic Auth.
-
Mandatory Field: EnqDetails must be supplied.
-
Minimum Contact Data: At least one of PersonName, Add1, Postcode, or Email must be present.
-
Country Format: If provided, Country must be exactly 2 characters.
-
Phone Data: If any phone field (Landline, Mobile, Fax) is provided, it must contain at least one digit after cleaning.
5. cURL Example
This example demonstrates submitting an enquiry using Basic Auth and providing the minimum required fields (EnqDetails and Email).
# Replace 'YOUR_API_KEY' and 'YOUR_PASSWORD' with your actual credentials
curl -X POST 'https://api.autovusolutions.com/api/WebEnquiry.aspx' \
-u 'YOUR_API_KEY:YOUR_PASSWORD' \
--data-urlencode 'TagName=Web Contact Form' \
--data-urlencode 'PersonName=Jane Doe' \
--data-urlencode 'Email=jane.doe@example.com' \
--data-urlencode 'Mobile=07700900123' \
--data-urlencode 'Postcode=W1A 0AA' \
--data-urlencode 'Country=GB' \
--data-urlencode 'EnqType=Sales Lead' \
--data-urlencode 'EnqDetails=I am interested in your services and require a callback regarding the Pro package.'
Success Response
{
"Status": "Success",
"DataID": 79562,
"PersonName": "John Doe",
"CompanyName": "",
"TagName": "",
"HouseName": "",
"Add1": "",
"Add2": "",
"Town": "",
"County": "",
"PostCode": "",
"Country": "GB",
"Landline": "",
"Mobile": "",
"Fax": "",
"Email": "john.doe@example.com",
"Web": "",
"EnqDetails": "I am interested in service X, please call me back.",
"AdditionalNotes": "",
"ErrorMessage": "",
"LocationID": "WebEnquiry"
}
Fail Response
{
"Status": "Fail",
"ErrorMessage": "WebEnquiry failed validation: Enquiry Details (EnqDetails) is mandatory.",
"LocationID": "WebEnquiry"
}