Custom All-in-One API
Description
Custom all-in-one APIs integrate the functionality of multiple core APIs into a customizable workflow. The API accepts your input data and returns a comprehensive response with all relevant results.
Request URL
https://api.rrdblive.com/DDM/WebService.cfc?method=process
Supported HTTP methods: GET or POST
Authentication Parameters
| ClientID | Your "Client ID" |
| CWSID | Your "Client Web Service ID" |
| Token | A token that is authorized to process this web service request |
Required Parameters
At least one of the following fields (or combinations) are required:
| MailAddress1 | Contact's street address |
| PostalZipCode | Contact's zip code |
| AND/OR | |
| PhoneNumber | Contact's phone number |
| AND/OR | |
| EmailAddress | Contact's email address |
Your custom All-in-One API may have different required and optional parameters
Optional Parameters
| FirstName | Contact's first name |
| MiddleName | Contact's middle name |
| LastName | Contact's last name |
| MailAddress2 | Contact's street address line 2 (if applicable) |
| CityName | Contact's city name |
| ProvinceStateName | Contact's state name or code |
| CountryName | Contact's country name or code |
| LeadIPAddress | Contact's IP address |
| LeadUserAgent | Contact's HTTP User-Agent |
| LeadAcceptLanguage | Contact's HTTP Accept-Language |
| LeadDeviceID | Contact's device ID |
| LeadExternalID | A custom ID for the lead (alphanumeric up to 255 characters) |
| ReferenceSubName | A custom reference name (alphanumeric up to 50 characters) |
| ReferenceSubID | A custom reference ID (integer) |
Parameters may be passed as either URL query parameters or posted as FORM fields
Response JSON
{
"success": true,
"errors": [],
"dataIn": [
],
"dataOut": [
]
}
Response Keys
| Key | Description |
|---|---|
| success | "true" if request was successful / "false" if errors occurred |
| errors | If "success" was "false", will contain an array of error objects. See below for sample error response. |
| dataIn | The original input data |
| dataOut | If "success" was "true", will return your custom "dataOut" results |
Sample Error Response JSON
{
"success": false,
"errors": [
{
"errorID": 1000,
"errorHeader": "Authentication Failed",
"errorMessage": "API user access denied"
}
]
}
4xx HTTP Status Code will be returned for all of the following:
| errorID | errorHeader | errorMessage |
|---|---|---|
| 400 | API Error | Depends on the cause of error |
| 403 | API Error | This API supports HTTPS only |
| 500 | Unexpected Error | Depends on the cause of error |
| 1000 | Authentication Failed | Depends on the cause of error |
| 2000 | Validation Error | Required fields are missing or blank |
| 35030 | Web Service Error | Active web service was not found |
| 35040 | Web Service Error | The supplied Token is not authorized for use with this CWSID |
| 35050 | Web Service Error | No data was submitted |
| 35060 | Web Service Error | Depends on the cause of error |
| 35070 | Web Service Error | This web service supports only one record at a time |