Methods

The following methods are available in the Record Validation Apex API:

• validateAddress(addressInput)
  Lets you validate an address.
• suggestAddress(addressSuggest)
  Lets you suggest an address based on partial input.
• completeAddress(addressInput)
  Will return the complete address from a selected suggestion.
• validateEmail(emailInput)
  Lets you validate an email address.
• suggestEmail(emailInput)
  Lets you suggest an email address based on partial input.
• validatePhone(phoneInput)
  Lets you validate phone numbers.
• saveValidationResult(rv2SaveValidationResultInput_v1)
  Lets you save the validation result to a record.

Models

• AddressValidationInput_V1
• AddressValidationOutput_V1
• AddressSuggestInput_V1
• AddressSuggestOutput_V1
• AddressCompleteInput_V1
• AddressCompleteOutput_V1
• EmailValidationInput_V1
• EmailValidationOutput_v1
• EmailSuggestInput_V1
• EmailSuggestOutput_V1
• PhoneValidationInput_V1
• PhoneValidationOutput_V1
• rv2SaveValidationResultInput_v1
• rv2SaveValidationResultOutput_v1

Status Codes

• Address Validation Status codes
• Geocode Status Codes
• Email Validation Status codes
• Phone Validation Status codes

validateAddress(addressInput)

Lets you validate an address.

Signature

global AddressValidationOutput_v1 validateAddress(AddressValidationInput_V1 addressInput)

Parameters
addressInput - Type: AddressValidationInput_V1

Return Value
Type: AddressValidationOutput_V1

Example

recordval.RecordValidationAPI_v1 api = new recordval.RecordValidationAPI_v1();
 recordval.AddressValidationInput_v1 input = new recordval.AddressValidationInput_v1();
input.street = 'Velperweg 8';
input.country = 'NL';
input.note = 'demo';
 recordval.AddressValidationOutput_v1 output = api.validateAddress(input);
System.debug(LoggingLevel.DEBUG, output.advice);
System.debug(LoggingLevel.DEBUG, output.addresses.get(0).advice);

suggestAddress(addressSuggest)

Lets you suggest an address based on partial input.

Signature

global AddressSuggestOutput_v1 suggestAddress(AddressSuggestInput_V1 addressSuggest)

Parameters

addressSuggest - Type: AddressSuggestInput_V1

Return Value

Type: AddressSuggestOutput_V1

Example

recordval.RecordValidationAPI_v1 api = new recordval.RecordValidationAPI_v1();
recordval.AddressSuggestInput_v1 input = new recordval.AddressSuggestInput_v1();
input.address = 'Velperweg 8'; 
input.country = 'NL';
input.note = 'demo';
recordval.AddressSuggestOutput_v1 output = api.suggestAddress(input);
System.debug(LoggingLevel.DEBUG, output.suggestions.get(0));
System.debug(LoggingLevel.DEBUG, output.status);

completeAddress(addressInput)

Will return the complete address from a selected suggestion.

Signature

global AddressCompleteOutput_v1 completeAddress(AddressSuggestInput_V1 addressInput)

Parameters

completeAddress - Type: AddressCompleteInput_V1

Return Value

Type: AddressCompleteOutput_V1

Example

recordval.RecordValidationAPI_v1 api = new recordval.RecordValidationAPI_v1();
recordval.AddressCompleteInput_v1 input = new recordval.AddressCompleteInput_v1();
input.address = 'Velperweg 8'; 
input.country = 'NL';
input.index = 0;
input.note = 'demo';
recordval.AddressCompleteOutput_v1 output = api.suggestAddress(input);
System.debug(LoggingLevel.DEBUG, output.address.advice);
System.debug(LoggingLevel.DEBUG, output.address.countryCode);

validateEmail(emailInput)

Signature

global EmailValidationOutput_v1 validateEmail(EmailValidationInput_V1 emailInput)

Parameters

validateEmail - Type: EmailValidationInput_V1

Return Value

Type: EmailValidationOutput_V1

Example

recordval.RecordValidationAPI_v1 api = new recordval.RecordValidationAPI_v1();
recordval.EmailValidationInput_v1 input = new recordval.EmailValidationInput_v1();
input.emailAddress = 'demo@plauti.com';
input.note = 'demo';
recordval.EmailValidationOutput_v1 output = api.validateEmail(input);
System.debug(LoggingLevel.DEBUG, output.advice);
System.debug(LoggingLevel.DEBUG, output.status);

suggestEmail(emailInput)

Signature

global EmailSuggestOutput_v1 suggestEmail(EmailSuggestInput_V1 emailInput)

Parameters

suggestEmail - Type: EmailSuggestInput_V1

Return Value

Type: EmailSuggestOutput_V1

Example

recordval.RecordValidationAPI_v1 api = new recordval.RecordValidationAPI_v1();
recordval.EmailSuggestInput_v1 input = new recordval.EmailSuggestInput_v1();
input.emailAddress = 'demo@plauti.com';
input.note = 'demo';
recordval.EmailSuggestOutput_v1 output = api.suggestEmail(input);
System.debug(LoggingLevel.DEBUG, output.suggestions.get(0));
System.debug(LoggingLevel.DEBUG, output.status);

validatePhone(phoneInput)

Signature

global PhoneValidationOutput_v1 validatePhone(PhoneValidationInput_V1 phoneInput)

Parameters

validatePhone - Type: PhoneValidationInput_V1

Return Value

Type: PhoneValidationOutput_V1

Example

recordval.RecordValidationAPI_v1 api = new recordval.RecordValidationAPI_v1();
recordval.PhoneValidationInput_v1 input = new recordval.PhoneValidationInput_v1();
input.phoneNumber = '0031-345677733'; 
input.country = 'NL'; 
input.format = PhoneFormat_v1.INTERNATIONAL;
input.note = 'demo';
recordval.PhoneValidationOutput_v1 output = api.validatePhone(input); 
System.debug(LoggingLevel.DEBUG, output.advice);
System.debug(LoggingLevel.DEBUG, output.status); 
System.debug(LoggingLevel.DEBUG, output.phoneNumber);

saveValidationResult(rv2SaveValidationResultInput_v1)

Signature

global rv2SaveValidationResultOutput_v1 saveValidationResult(
        rv2SaveValidationResultInput_v1 saveValidationRequest
    )

Parameters

saveValidationRequest - Type: rv2SaveValidationResultInput_v1

Return Value

Type: rv2SaveValidationResultOutput_v1

Example

// Create a new rv2SaveResultsInputObject
recordval.rv2SaveValidationResultInput_v1 saveResults = new recordval.rv2SaveValidationResultInput_v1();
// Set the recordId in which the result needs to be stored
saveResults.setRecordId(recordId);
// Pass the fieldName that needs to be validated and the result from the validation
saveResults.setValidationResult(fieldName, output);
recordval.rv2SaveValidationResultOutput_v1 result = api.saveValidationResult(saveResults);

System.debug(LoggingLevel.debug, result.recordId);
System.debug(LoggingLevel.debug, result.success);

AddressValidationinput_V1

AddressOptions_v1

AddressValidationOutput_V1

Addresses

Advice_v1

Status_v1

AddressSuggestInput_v1

AddressSuggestOutput_v1

Status_V1

AddressCompleteInput_v1

AddressOptions_v1

AddressCompleteOutput_v1

Address_v1

Status_v1

Advice_v1

EmailValidationInput_v1

EmailValidationOutput_v1

Status_v1

Advice_v1

EmailSuggestInput_v1

EmailSuggestOutput_v1

Status_v1

PhoneValidationInput_v1

Format_v1

PhoneValidationOutput_v1

Status_v1

Advice_v1

rv2SaveValidationResultInput_v1

rvSaveValidationResultOutput_v1