RedFlag :: API

Mit Hilfe der RedFlag-Web-API könnt ihr die Qualität von Adressdaten prüfen.

Methoden

CheckContact

Prüft einContact-Objekt und gibt das Ergebnis zurück.

URL: http(s)://$server/CheckContact

Method: POST

Request

{
  "type": "person" or "org",
  "id": string,
  "salutation": string,
  "title": string,
  "firstname": string,
  "lastname": string,
  "org": string,
  "street1": string,
  "street2": string,
  "zip": string,
  "city": string,
  "countrycode": string,
  "phone": string,
  "fax": string,
  "email": string
}

Wenn eine Property nicht angeben wird, wird der Wert als ein leerer String interpretiert. Bei der Property type wird als Default-Wert “person” verwendet.

Response

{
  "contactId": string,
  "score": integer,
  "messages": [string, string, ...]
}

CheckContactList

Prüft eine Liste von Contact-Objekten und gibt die Ergebnisse als Liste zurück.

URL: http(s)://$server/CheckContactList

Method: POST

Request

[{
  "type": "person" or "org",
  "id": string,
  "salutation": string,
  "title": string,
  "firstname": string,
  "lastname": string,
  "org": string,
  "street1": string,
  "street2": string,
  "zip": string,
  "city": string,
  "countrycode": string,
  "phone": string,
  "fax": string,
  "email": string
},
{
  "type": "person" or "org",
  "id": string,
  "salutation": string,
  "title": string,
  "firstname": string,
  "lastname": string,
  "org": string,
  "street1": string,
  "street2": string,
  "zip": string,
  "city": string,
  "countrycode": string,
  "phone": string,
  "fax": string,
  "email": string
},
{...},
...]

Wenn eine Property nicht angeben wird, wird der Wert als ein leerer String interpretiert. Bei der Property type wird als Default-Wert “person” verwendet.

Response

[{
  "contactId": string,
  "score": integer,
  "messages": [string, string, ...]
},
{
  "contactId": string,
  "score": integer,
  "messages": [string, string, ...]
},
{...},
...]