Search

Resource type: search

This can be used to search for data records based on defined criteria, similar to the search in enterprise. The type of record searched for is specified in the resource identifier (address, estate, search criteria).

Resource ID: address, estate, searchcriteria

Parameters (general):

  • input
    Contains the search term to search for. This must not be empty.
  • extendedclaim
    STRING. Mandatory for marketplace providers. Not relevant for all other users. To verify the user which uses the marketplace return the “apiClaim” parameter from the service call as “extendedclaim”. User rights are then observed by the marketplace provider API user (not applicable for search criteria).

Parameters (address):

  • includecontactdata
    OPTIONAL. Search includes secondary contact information (phone/email) rather than just the main information
  • casesensitive
    OPTIONAL. Search is case-sensitive
  • searchparameter
    OPTIONAL. Array of fields to include in the search
  • listlimit
    OPTIONAL. Maximum number of records returned
  • extendedclaim
    STRING. Mandatory for marketplace providers. Not relevant for all other users. To verify the user which uses the marketplace return the “apiClaim” parameter from the service call as “extendedclaim”. User rights are then observed by the marketplace provider API user.

Response (address):

  • customerno
    Customer number
  • firstname
    First name in the address record
  • surname
    Last name in the address record
  • company
    Company in the address record
  • emailaddress
    Primary email address in the address record

Response (estate):

  • externalestateno
    external property number
  • city
    City of the estate
  • street
    Street of the estate
  • owner
    First and last name of the owner