Lijst

Een nieuwe lijst, uit adressen of een bestand.

Geef de adressen mee in adressen, elk als tekst ("Spuistraat 36C, 1012 TT Amsterdam") of als object met straat, huisnummer, huisletter, toevoeging, postcode en plaats; ref en jaar per adres mogen erbij. Of stuur een Excel- of CSV-bestand in base64 in bestand, met bestandsnaam. Hebben de adressen geen postcode of plaats, geef dan plaats mee.

Daarna loopt de gratis proef: we zoeken alle adressen op en vragen er vijf op. Vraag de stand op met GET op links.status, met ?wacht=20 om te wachten tot hij klaar is. Dezelfde lijst binnen een uur opnieuw sturen geeft dezelfde lijst terug.

post/Api/Lijst

Request

  • Base URL: https://woz-api.nl
  • URL: https://woz-api.nl/Api/Lijst
  • Auth: API key in header X-Api-Key

Request body

bestandstring nullable

Een Excel- of CSV-bestand in base64, in plaats van adressen.

bestandsnaamstring nullable

Naam van dat bestand, met extensie (.xlsx, .xls of .csv).

plaatsstring nullable

De plaats voor alle adressen zonder postcode of plaats. "Kerkstraat 12" bestaat in veel plaatsen.

emailstring nullable

Het eigen e-mailadres van de gebruiker voor de levering; alvast ingevuld op de betaalpagina.

Response

De lijst en zijn stand.

tokenstring nullable

Het token van de lijst: wie het heeft, kan de lijst lezen en betalen. Niet in een URL voor derden zetten.

statusstring nullable

kolommen_kiezen, proef_bezig, niets_herkend, wacht_op_betaling, bezig, klaar of mislukt.

avgstring nullable

Hoe de gebruiker met de uitkomst omgaat.

volgendeControleNaSecondeninteger nullable

Na zoveel seconden is er waarschijnlijk iets veranderd; leeg als er niets te wachten valt.

aangemaaktOpstring date-time
geleverdOpstring date-time nullable
apiToegangTotstring date-time nullable

Tot wanneer de API deze lijst nog toont; de link uit de bezorgmail blijft daarna werken.

Changes

No recorded changes to this operation across all 1 revision of this API.