Inschrijfformulier zoekers

Versturen van formulier

POST http://api.yes-co.com/1.0/searcher/signup

Er is geen authenticatie nodig om gebruik te maken van deze API module

Parameters

Parameter Soort Verplicht Omschrijving
yesco_key string Ja Yes-co system identifier. Kan achterhaald worden bij de Inschrijfformulier zoekers app in de Yes-co App Market.
charset string Nee Gebruikte karakter set van het formulier. Indien de charset niet meegestuurd wordt, wordt uitgegaan van de ISO-8859-15 karakter set. Ondersteunde karakter sets: UTF-8, ISO-8859-1, ISO-8859-15.
developer_mode boolean Nee Indien de developer mode op false gezet wordt, dan wordt er na het versturen van het formulier informatie getoond over welke gegevens verstuurd zouden worden als de developer mode niet aan stond. Formulieren waarbij de developer mode aan staat worden dus niet daadwerkelijk verstuurd.
thank_you_page string Nee Url waar de gebruiker naar doorgestuurd wordt na het versturen van het formulieren. Gebruik is niet verplicht maar wordt wel aangeraden!
source string Nee Afzender van het formulier. Standaard: Website.
title string Nee Titel van formulier. Gebruik is niet verplicht maar wordt wel aangeraden.
project_tags array Nee Tags die aan het formulier gekoppeld moeten worden.
office[api-object-id] int Nee API Object ID van vestiging.
person[lastname] string Ja Achternaam van de relatie.
person[firstname] string Nee Voornaam van de relatie.
person[email] string Nee E-mail adres van de relatie.
person[phone] string Nee Telefoon nummer van de relatie.
person[city] string Nee Plaats waar de relatie woont.
person[street] string Nee Straat waar de relatie woont.
person[housenumber] string Nee Huisnummer van de relatie.
person[zipcode] string Nee Postcode van de relatie.
relation_tags array Nee Tags die aan de (nieuwe) relatie gekoppeld moeten worden.
searchprofile[city] array Nee Plaatsnamen waar binnen gezocht kan worden.
searchprofile[price-min] int Nee Minimum prijs.
searchprofile[price-max] int Nee Maximale prijs.
searchprofile[woonhuis][soort] array Nee Soort woonhuis.
searchprofile[woonhuis][type] array Nee Type woonhuis.
searchprofile[woonhuis][kenmerk] array Nee Kenmerk woonhuis.
searchprofile[appartement][soort] array Nee Soort appartement.
searchprofile[appartement][kenmerk] array Nee Kenmerk appartement.
searchprofile[bouwjaar-min] int Nee Bouwjaar vanaf.
searchprofile[bouwjaar-max] int Nee Bouwjaar t/m.
searchprofile[aantalkamers] int Nee Minimum aantal kamers.
searchprofile[woonoppervlakte] int Nee Minimum woonoppervlakte.
searchprofile[perceeloppervlakte] int Nee Minimum perceeloppervlakte.
searchprofile[tuin] string Nee Aanwezigheid tuin (mogelijke waardes: ja, nee).
searchprofile[garage] string Nee Aanwezigheid garage (mogelijke waardes: ja, nee).
searchprofile[einddatum] string Nee Eind datum (dd-mm-YYYY) van zoekprofiel. Zoeker wordt dan automatisch uitgeschreven.
searchprofile[opmerkingen] string Nee Vrije invoer voor additionele woonwensen.

Antwoord

Wanneer de developer mode uit staat wordt de gebruiker middels een HTTP redirect (303) naar de thank_you_page doorgestuurd.

Wanneer de developer mode aan staat wordt er een HTML pagina met diagnostisch informatie terug gegeven:

Voorbeeld

Hieronder wordt een voorbeeld formulier getoond met bijbehorende HTML. Je kan deze HTML kopiëren en gebruiken of zelf de HTML aanpassen.

Om spam enigzins tegen te gaan kunnen de voorbeeld formulieren enkel verstuurd worden als de cliënt javascript ondersteuning heeft. Desgewenst kan de HTML van het formulier aangepast worden zodat er geen javascript ondersteuning nodig is om het formulier te versturen, dit is echter geheel op eigen risico.

Formulier

<form method="post" action="#" onsubmit="this.action = 'http://api.yes-co.com/1.0/searcher/signup';">
  <!–- Yes-co systeem key, te genereren in App Market, verplicht! –->
  <input type="hidden" name="yesco_key" value="vul waarde Yes-co key in " />

  <!–- Gebruik developer_mode = true om de werking van het formulier te checken –->
  <input type="hidden" name="developer_mode" value="false" />

  <!–- De pagina die getoond moet worden na het versturen van het formulier –->
  <input type="hidden" name="thank_you_page" value="vul url in" />

  <!–- De titel van het formulier –->
  <input type="hidden" name="title" value="vul titel in" />

  <!–- De tags die aan het aan te maken WOzo project gehangen moeten worden –->
  <input type="hidden" name="project_tags[0]" value="Tag 1" />
  <input type="hidden" name="project_tags[1]" value="Tag 2" />

  <!–- De tags die standaard aan de gekoppelde relatie gehangen moeten worden –->
  <input type="hidden" name="relation_tags[]" value="via website" />

  <!-– De afkomst van het formulier –->
  <input type="hidden" name="source" value="Website" />

  <!-– De einddatum van de zoekopdracht –->
  <input type="hidden" name="searchprofile[einddatum]" value="31-12-2028" />

  <!–- Voornaam van relatie –->
  <div>
    <label>Voornaam:</label>
    <input type="text" name="person[firstname]" value="" />
  </div>

  <!–- Achternaam van relatie –->
  <div>
    <label>Achternaam:</label>
    <input type="text" name="person[lastname]" value="" class="required" />
  </div>

  <!–- E-mail adres van relatie –->
  <div>
    <label>E-mail:</label>
    <input type="email" name="person[email]" value="" class="required" />
  </div>

  <!–- Telefoon nummer van relatie –->
  <div>
    <label>Telefoon:</label>
    <input type="tel" name="person[phone]" value="" />
  </div>

  <!–- Woonplaats van relatie –->
  <div>
    <label>Plaats:</label>
    <input type="text" name="person[city]" value="" />
  </div>

  <!–- Straatnaam van relatie –->
  <div>
    <label>Straat:</label>
    <input type="text" name="person[street]" value="" />
  </div>

  <!–- Postcode van relatie –->
  <div>
    <label>Postcode:</label>
    <input type="text" name="person[zipcode]" value="" />
  </div>

  <!–- Huisnummer van relatie –->
  <div>
    <label>Huisnummer:</label>
    <input type="text" name="person[housenumber]" value="" />
  </div>

  <!–- Plaatsnamen binnen zoekgebied –->
  <div>
    <label>Plaatsen:</label>
    <select name="searchprofile[city][]" multiple size="3">
      <option value="ALKMAAR">ALKMAAR</option>
      <option value="ALMERE">ALMERE</option>
      <option value="AMSTERDAM">AMSTERDAM</option>
    </select>
  </div>

  <!–- Minimum prijs –->
  <div>
    <label>Prijs vanaf:</label>
    <select name="searchprofile[price-min]">
      <option value="">Geen voorkeur</option>
      <option value="100000">100.000</option>
      <option value="125000">125.000</option>
      <option value="150000">150.000</option>
      <option value="175000">175.000</option>
      <option value="200000">200.000</option>
      <option value="225000">225.000</option>
      <option value="250000">250.000</option>
      <option value="275000">275.000</option>
      <option value="300000">300.000</option>
      <option value="350000">350.000</option>
      <option value="400000">400.000</option>
      <option value="450000">450.000</option>
      <option value="500000">500.000</option>
      <option value="600000">600.000</option>
      <option value="700000">700.000</option>
      <option value="800000">800.000</option>
      <option value="900000">900.000</option>
      <option value="1000000">1.000.000</option>
      <option value="1500000">1.500.000</option>
      <option value="2000000">2.000.000</option>
    </select>
  </div>

  <!–- Maximum prijs –->
  <div>
    <label>Prijs tot:</label>
    <select name="searchprofile[price-max]">
      <option value="">Geen voorkeur</option>
      <option value="100000">100.000</option>
      <option value="125000">125.000</option>
      <option value="150000">150.000</option>
      <option value="175000">175.000</option>
      <option value="200000">200.000</option>
      <option value="225000">225.000</option>
      <option value="250000">250.000</option>
      <option value="275000">275.000</option>
      <option value="300000">300.000</option>
      <option value="350000">350.000</option>
      <option value="400000">400.000</option>
      <option value="450000">450.000</option>
      <option value="500000">500.000</option>
      <option value="600000">600.000</option>
      <option value="700000">700.000</option>
      <option value="800000">800.000</option>
      <option value="900000">900.000</option>
      <option value="1000000">1.000.000</option>
      <option value="1500000">1.500.000</option>
      <option value="2000000">2.000.000</option>
    </select>
  </div>

  <!–- Soort woonhuis –->
  <div>
    <label>Soort woonhuis:</label>
    <select name="searchprofile[woonhuis][soort][]" multiple size="3">
      <option value="bungalow">Bungalow</option>
      <option value="eengezinswoning">Eengezinswoning</option>
      <option value="grachtenpand">Grachtenpand</option>
      <option value="herenhuis">Herenhuis</option>
      <option value="landgoed">Landgoed</option>
      <option value="landhuis">Landhuis</option>
      <option value="stacaravan">Stacaravan</option>
      <option value="villa">Villa</option>
      <option value="woonboerderij">Woonboerderij</option>
      <option value="woonboot">Woonboot</option>
      <option value="woonwagen">Woonwagen</option>
    </select>
  </div>

  <!–- Type woonhuis –->
  <div>
    <label>Type woonhuis:</label>
    <select name="searchprofile[woonhuis][type][]" multiple size="3">
      <option value="2-onder-1-kapwoning">2-onder-1-kapwoning</option>
      <option value="eindwoning">Eindwoning</option>
      <option value="geschakelde 2-onder-1-kapwoning">Geschakelde 2-onder-1-kapwoning</option>
      <option value="geschakelde woning">Geschakelde woning</option>
      <option value="halfvrijstaande woning">Halfvrijstaande woning</option>
      <option value="hoekwoning">Hoekwoning</option>
      <option value="tussenwoning">Tussenwoning</option>
      <option value="vrijstaande woning">Vrijstaande woning</option>
    </select>
  </div>

  <!–- Kenmerk woonhuis –->
  <div>
    <label>Type woonhuis:</label>
    <select name="searchprofile[woonhuis][kenmerk][]" multiple size="3">
      <option value="bedrijfs- of dienstwoning">Bedrijfs- of dienstwoning</option>
      <option value="dijkwoning">Dijkwoning</option>
      <option value="drive-in woning">Drive-in woning</option>
      <option value="hofjeswoning">Hofjeswoning</option>
      <option value="kwadrantwoning">Kwadrantwoning</option>
      <option value="paalwoning">Paalwoning</option>
      <option value="patiowoning">Patiowoning</option>
      <option value="semi-bungalow">Semi-bungalow</option>
      <option value="split-level woning">Split-level woning</option>
      <option value="waterwoning">Waterwoning</option>
      <option value="wind/watermolen">Wind/watermolen</option>
    </select>
  </div>

  <!–- Soort appartement –->
  <div>
    <label>Soort appartement:</label>
    <select name="searchprofile[appartement][soort][]" multiple size="3">
      <option value="beneden + bovenwoning">Beneden + bovenwoning</option>
      <option value="benedenwoning">Benedenwoning</option>
      <option value="bovenwoning">Bovenwoning</option>
      <option value="dubbel benedenhuis">Dubbel benedenhuis</option>
      <option value="galerijflat">Galerijflat</option>
      <option value="maisonnette">Maisonnette</option>
      <option value="penthouse">Penthouse</option>
      <option value="portiekflat">Portiekflat</option>
      <option value="portiekwoning">Portiekwoning</option>
      <option value="studentenkamer">Studentenkamer</option>
      <option value="tussenverdieping">Tussenverdieping</option>
    </select>
  </div>

  <!–- Kenmerk appartement –->
  <div>
    <label>Kenmerk appartement:</label>
    <select name="searchprofile[appartement][kenmerk][]" multiple size="3">
      <option value="appartement">Appartement</option>
      <option value="bel-etage">Bel-etage</option>
      <option value="corridorflat">Corridorflat</option>
      <option value="dubbel bovenhuis">Dubbel bovenhuis</option>
      <option value="service flat">Service flat</option>
      <option value="souterrain">Souterrain</option>
      <option value="verzorgingsflat">Verzorgings flat</option>
    </select>
  </div>

  <!–- Bouwjaar min –->
  <div>
    <label>Bouwjaar min:</label>
    <input name="searchprofile[bouwjaar-min]" type="number" step="10" max="2018" value="" />
  </div>

  <!–- Bouwjaar max –->
  <div>
    <label>Bouwjaar max:</label>
    <input name="searchprofile[bouwjaar-max]" type="number" step="10" max="2018" value="" />
  </div>

  <!–- Min aantal kamers –->
  <div>
    <label>Min aantal kamers:</label>
    <input name="searchprofile[aantalkamers]" type="number" step="1" value="" />
  </div>

  <!–- Min woonoppervlakte –->
  <div>
    <label>Min woonoppervlakte:</label>
    <input name="searchprofile[woonoppervlakte]" type="number" step="1" value="" />
  </div>

  <!–- Min perceeloppervlakte –->
  <div>
    <label>Min perceeloppervlakte:</label>
    <input name="searchprofile[perceeloppervlakte]" type="number" step="1" value="" />
  </div>

  <!–- Tuin –->
  <div>
    <label>Tuin:</label>
    <select name="searchprofile[tuin]">
      <option value="">Geen voorkeur</option>
      <option value="ja">Ja</option>
      <option value="nee">Nee</option>
    </select>
  </div>

  <!–- Garage –->
  <div>
    <label>Garage:</label>
    <select name="searchprofile[garage]">
      <option value="">Geen voorkeur</option>
      <option value="ja">Ja</option>
      <option value="nee">Nee</option>
    </select>
  </div>

  <!–- Opmerkingen  –->
  <div>
    <label>Opmerkingen:</label>
    <textarea name="searchprofile[opmerkingen]"></textarea>
  </div>

  <!–- Knop om formulier te versturen –->
  <input type="submit" value=" Versturen " />
</form>

<!–- Javascript om de verplichte velden te valideren –->
<script type="text/javascript" src="http://api.yes-co.com/1.0/embed/js/response-forms.js"></script>