SOAP method reference

This section is a wrapper used to provide Clean Web Service with an array of records for processing.

SOAP Snippet

<ns:records>
  <ns:record>
    <ns:fields>
      <arr:string>REF001</arr:string>
      <arr:string>MetaFiction Ltd,14 Old St,London</arr:string>
      <arr:string>contact@metafiction.com</arr:string>
    </ns:fields>
  </ns:record>
</ns:records>

Comments

Each record is provided within a Record tag. Within this, the Fields block contains an array ofstrings , which each hold a different kind of field. In the example above, the Record contains the followingstrings :

<arr:string>REF001</arr:string>

This is a ReferenceField. It will not be processed, but will be included in the corresponding Record block in the response.

<arr:string>MetaFiction Ltd,14 Old St,London</arr:string>

This is a postal address string. All organisation information (if included) must appear as the first element of the postal address string.
The processing of organisation information is currently only supported when using the FRX AddressDataSet setting with a Layout that supports the processing of organisation data. For other datasets, these fields will be processed as normal address elements.
The remaining parts of the string are are 'normal' postal address elements.
When using the CleanEnrich workflow only, postal address records can be provided as multiple strings (for example, one address line perstring ).

<arr:string>contact@metafiction.com</arr:string>

This is an email address string.

You can use as many strings as required to provide the individual lines you have available for each record. Each successfully matched address will be cleaned and returned using the Layout you specify in the settings section.

You may include a maximum of 1000 Record tags within each request. The sample pages show a method of splitting a larger collection of records into 1000-record chunks.

Response

The response will also include a records section, containing Record tags which correspond to those you provided. In the event that a postal or email address cannot be matched, the corresponding strings will be empty.

The Fields which are returned will depend on the workflow you specify.

This section identifies the workflow which should be applied to the address records sent in a request.

SOAP Snippet

<ns:workflow>CleanEnrich</ns:workflow>

Comments

This section must be used in every call. It informs Clean Web Service of the type of cleaning that should take place on each Record included in the request.

Values

The following workflows are available:

• CleanEnrich
• EmailValidate
• CleanEnrichEmailValidate {end-accordion-section}

This section is a wrapper used to contain an array of settings particular to the workflow you have specified.

Soap Snippet

<ns:settings>
  <ns:namedvalue>
    <ns:key>UserLabel</ns:key>
    <ns:value>CleanTest</ns:value>
  </ns:namedvalue>
  ...
</ns:settings>

Comments

This section must be used in every call. Each NamedValue tag represents a setting, which is communicated to Clean Web Service as a key/value pair.

Values

The settings available for each workflow are as follows:

CleanEnrich

_ * the InputFieldMappings and ReferenceField settings are equivalent and cannot be used together (InputFieldMappings takes precedence). If you include a reference field in your data, you must use one of these settings._

EmailValidate

CleanEnrichEmailValidate

Response

The response will include Record tags corresponding to those you send in records section of the request, any optional fields you request using the settings above and (for workflows which include postal addresses) any DataPlus fields that are included in the Layout you specify (where a such fields can be found for a given address).