LijstAanvraag

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/woz-api-nl/json-schema/woz-api-nl-lijst-aanvraag-schema.json",
  "title": "LijstAanvraag",
  "description": "Een nieuwe lijst: adressen, of een bestand in base64.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/woz-api-nl-openapi.json#/components/schemas/LijstAanvraag",
  "type": "object",
  "properties": {
    "adressen": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/LijstAdres"
      },
      "description": "De adressen, elk als tekst (\"Spuistraat 36C, 1012 TT Amsterdam\") of als object met straat,\r\nhuisnummer, huisletter, toevoeging, postcode, plaats, en eventueel ref en jaar."
    },
    "bestand": {
      "type": [
        "string",
        "null"
      ],
      "description": "Een Excel- of CSV-bestand in base64, in plaats van adressen."
    },
    "bestandsnaam": {
      "type": [
        "string",
        "null"
      ],
      "description": "Naam van dat bestand, met extensie (.xlsx, .xls of .csv)."
    },
    "plaats": {
      "type": [
        "string",
        "null"
      ],
      "description": "De plaats voor alle adressen zonder postcode of plaats. \"Kerkstraat 12\" bestaat in veel plaatsen."
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "Het eigen e-mailadres van de gebruiker voor de levering; alvast ingevuld op de betaalpagina."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "LijstAdres": {
      "type": "object",
      "properties": {
        "tekst": {
          "type": [
            "string",
            "null"
          ],
          "description": "Het hele adres als tekst. Wint van de losse velden als beide er zijn."
        },
        "straat": {
          "type": [
            "string",
            "null"
          ]
        },
        "huisnummer": {
          "type": [
            "string",
            "null"
          ]
        },
        "huisletter": {
          "type": [
            "string",
            "null"
          ]
        },
        "toevoeging": {
          "type": [
            "string",
            "null"
          ]
        },
        "postcode": {
          "type": [
            "string",
            "null"
          ]
        },
        "plaats": {
          "type": [
            "string",
            "null"
          ]
        },
        "ref": {
          "type": [
            "string",
            "null"
          ],
          "description": "Een eigen kenmerk van de gebruiker (objectnummer, regelnummer); komt terug in het bestand."
        },
        "jaar": {
          "type": [
            "string",
            "null"
          ],
          "description": "Een jaartal per adres, voor de keuze \"per rij uit een kolom\" op de betaalpagina."
        }
      },
      "additionalProperties": false,
      "description": "Een adres in een lijst van de API: een tekst (\"Spuistraat 36C, 1012 TT Amsterdam\") of losse\r\nvelden. Een AI-assistent heeft meestal het een of het ander, en we willen hem niet laten kiezen."
    }
  }
}