Data Quality user documentation
home/Address validation/Pro Web/API reference (REST)/Support API

Support API

To find out your system information

  1. Go to our your swagger editor and click the GET /support/sysinfo, so that it expands.
    GET /sysinfo swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what your system information is. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

To find out your license information and status for your available datasets:

  1. Go to our your swagger editor and click the GET /support/license, so that it expands.
    GET /license swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what your license information is for the available datasets. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

Response

Licensed dataset information

Name Type Description
dataset_code string The code used to identify the set.
description string A description of the dataset.
copyright string Copyright information.
Version string Version information.
base_country string The base country/set for this set.
status string Status text.
server string The server ID you are using.
license_warning string For information on license_warning see the license warning elements.
days_left integer The number of days left.
data_days_left integer The number of days left your dataset is available.
license_days_left integer The number of days left on your license.

License warning elements

For any addition information on your license please contact us.

Name Type Description
None string No warning.
DataExpiring string Your data is expiring.
DataUnreadable string The data you provided is incorrect.
LicenceExpiring string Your license is expiring.
ClicksLow string The metered clicks that control usage of the data are running low.
Evaluation string The license that controls the use of data is evaluation-only.
NoClicks string You do not have any clicks left.
DataExpired string Your access to this dataset has expired.
EvalLicenceExpired string Your evaluation license has expired.
FullLicenceExpired string Your full license has expired.
LicenceNotFound string We could not find a valid license.

get your counter information

  1. Go to our your swagger editor and click the GET /support/counter/system_info, so that it expands.
    GET /counter/system_info swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what your counter information. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

License information about your meter

  1. Go to our your swagger editor and click the GET /support/counter/meter, so that it expands.
    GET /counter/meter swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what your license information about your meter. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

Update code for your product counter

  1. Go to our your swagger editor and click the POST /support/counter/update, so that it expands.
    POST /counter/update swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what your update code is for your product counter. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

Current DPV status

  1. Go to our your swagger editor and click the GET /support/dpv/status, so that it expands.
    GET /support/dpv/status swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will tell you what your update code is for your product counter. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.

Response body parameters

Name Type Description
DPVNotConfigured string You havent configured the DPV.
DPVConfigured string The DPV has been configures and can be used.
DPVLocked string DPV lock status details:
  • date - The date you run this request.
  • time - The time you run this request.
  • seed_address - This contains the search string which was identified as a seed address.
  • lock_code - The lock code for the DPV.

DPV unlock

Unlocks a locked DPV, with an unlock code based on the DPV lock code (see DPV status response)

  1. Go to our your swagger editor and click the POST /support/dpv/unlock, so that it expands.
    POST /dpv/unlock swagger view
  2. Click Try it out in the upper-right corner.
  3. Click Execute to send the request to the API.
  4. View the response returned by the API under Responses. This will unlock a locked DPV. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out the possible Response status codes to find out more about scenarios where the API returns errors.
Pro Web

API reference (REST)