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):
See Search estate for more information on searching for estates.
See Search search criteria for more information on searching for search criteria.
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).
Below only the parameters for “Search address” are explained.
Parameters (address):
includecontactdata
OPTIONAL. Search includes secondary contact information (phone/email) rather than just the main informationcasesensitive
OPTIONAL. Search is case-sensitivesearchparameter
OPTIONAL. Array of fields to include in the searchlistlimit
OPTIONAL. Maximum number of records returnedsortby
OPTIONAL. STRING. Field to sort by. The field names from the administration must be used. HereKdNr
forcustomerno
,Vorname
forfirstname
,Name
forsurname
,Zusatz1
forcompany
,Email
foremailaddress
sortorder
OPTIONAL. STRING. Possible values:ASC
orDESC
. Ascending or descending
Request example
{ "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get", "resourceid": "address", "identifier": "", "resourcetype": "search", "parameters": { "input": "Max Mustermann" } }
Response (address
):
customerno
Customer numberfirstname
First name in the address recordsurname
Last name in the address recordcompany
Company in the address recordemailaddress
Email addresses in the address recordprimaryEmail
Primary email address in the address record
Response example
... { "id": 10775, "type": "address", "elements": { "customerno": 18446077777866, "surname": "Mustermann", "firstname": "Max", "company": "", "emailaddress": [ "max.mustermann@test153.de" ], "primaryEmail": "m.mustermann@onoffice.de" } }, ...