SearchContacts(sessionID, domainId, searchOption, searchValue, sortOrder, modifiedAfter, active, pageNumber)

Yuki Webservice - SearchContacts

Deze webservice stelt je in staat om relaties uit een domein te tonen die voldoen aan de ingevoerde zoekcriteria.

Parameters

sessionID 

De sessie ID zoals deze is verkregen met de methode Authenticate(accessKey).

domainID
De identifier van de administratie. Voor een beschrijving waar je de domainID kunt vinden zie artikel Common - Domains(sessionID).

searchOption: 

(searchoption waarde - toelichting)

• All - zoek in al de onderstaande velden naar de ingevoerde searchValue
• Name - naam
• City - stad
• Postcode 
• Tag
• Email
• Website
• Phone - telefoonnummer
• Code - relatiecode
• CoCNumber - Kamer van Koophandel nummer
• VATNumber - btw-nummer
• BankAccount - bankrekening.

searchValue (zoekwaarde)

De zoekwaarde waarnaar gezocht wordt in één van de bovenstaande zoekopties.

sortOrder (sortering van resultaten):

(sortOrder waarde - toelichting)

• Name - volledige contactnaam (voornaam + tussenvoegsel + achternaam)
• LastName - achternaam
• CreatedAsc - oplopend gesorteerd op aanmaakdatum
• CreatedDesc - aflopend gesorteerd op aanmaakdatum
• ModifiedAsc - oplopend gesorteerd op de laatste wijzigingsdatum
• ModifiedDesc - aflopend gesorteerd  op de laatste wijzigingsdatum
• HID - gesorteerd op de uniek human ID.

modifiedAfter (aangepast na)
Filter waarbij alleen contacten van na deze wijzigingsdatum worden opgenomen in het zoekresultaat.

active (actief):
(active waarde - toelichting)

• Both - Zowel actief als inactieve contacten opnemen in het resultaat
• Active - Alleen actieve contacten opnemen in het resultaat
• Inactive - Alleen inactieve contacten opnemen in het resultaat

pageNumber
Bij een resultaat met 100 contacten bestaat de mogelijkheid dat er nog meerdere pagina's met resultaten beschikbaar zijn.
Roep dan ook het eerstvolgende pageNumber aan tot er geen resultaten meer aanwezig zijn.