Class: BagKadasterClient::AdresApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bag_kadaster_client/api/adres_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdresApi

Returns a new instance of AdresApi.



19
20
21
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#bevraag_adressen(opts = {}) ⇒ AdresIOHalCollection

Bevragen van huidige adressen met een (combinatie van) zoek parameters. De volgende bevragingen worden ondersteund: <ol> <li> Bevragen van één huidig adres met de identificatie van een zoekresultaat verkregen via /adressen/zoek. </li> <li> Bevragen van één of meer huidige adressen met postcode, huisnummer en optioneel huisnummertoevoeging en huisletter. Parameter exacteMatch kan worden toegepast. </li> <li> Bevragen van één of meer huidige adressen met de identificatie van een adresseerbaar object. </li> <li> Bevragen van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en/of huisletter. Parameter exacteMatch kan worden toegepast. </li> <li> Bevragen van één of meer huidige adressen met de identificatie van een pand. Expand wordt niet ondersteund. </li> </ol> Bij de bovenstaande bevragingen kunnen eveneens de volgende parameters worden gebruikt (tenzij anders vermeld):<br/> Als expand=nummeraanduiding, openbareRuimte, woonplaats (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :zoekresultaat_identificatie (String) —

    De identificatie van een gekozen zoekresultaat uit de zoekResultatenHalCollectie verkregen bij een GET /adressen/zoek

  • :postcode (String) —

    Postcode behorende bij een nummeraanduiding.

  • :huisnummer (Integer) —

    Huisnummer behorende bij een nummeraanduiding.

  • :huisnummertoevoeging (String) —

    Huisnummertoevoeging behorende bij een nummeraanduiding.

  • :huisletter (String) —

    Huisletter behorende bij een nummeraanduiding.

  • :exacte_match (Boolean) —

    &quot;Een indicatie of de resultaten van een zoekoperatie exact overeen moeten komen met de zoekcriteria, zie [functionele specificatie exacte match](github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).&quot; (default to false)

  • :adresseerbaar_object_identificatie (String) —

    Identificatie van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) uit de BAG.

  • :woonplaats_naam (String) —

    Naam van een woonplaats.

  • :openbare_ruimte_naam (String) —

    Naam van een openbare ruimte.

  • :pand_identificatie (String) —

    Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.

  • :expand (String) —

    Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.

  • :page (Integer) —

    Pagina nummer (default to 1)

  • :page_size (Integer) —

    Aantal resultaten per pagina (default to 20)

Returns:



39
40
41
42
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 39

def bevraag_adressen(opts = {})
  data, _status_code, _headers = bevraag_adressen_with_http_info(opts)
  data
end

#bevraag_adressen_met_num_id(nummeraanduiding_identificatie, opts = {}) ⇒ AdresIOHal

Bevragen van een huidig adres met de identificatie van een nummeraanduiding. Bevragen van een huidig adres met de identificatie van een nummeraanduiding. Als expand=nummeraanduiding, openbareRuimte, woonplaats (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.

Parameters:

  • nummeraanduiding_identificatie (String) —

    Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.

Returns:



203
204
205
206
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 203

def bevraag_adressen_met_num_id(nummeraanduiding_identificatie, opts = {})
  data, _status_code, _headers = bevraag_adressen_met_num_id_with_http_info(nummeraanduiding_identificatie, opts)
  data
end

#bevraag_adressen_met_num_id_with_http_info(nummeraanduiding_identificatie, opts = {}) ⇒ Array<(AdresIOHal, Integer, Hash)>

Bevragen van een huidig adres met de identificatie van een nummeraanduiding. Bevragen van een huidig adres met de identificatie van een nummeraanduiding. Als expand&#x3D;nummeraanduiding, openbareRuimte, woonplaats (of een combinatie daarvan) of als expand&#x3D;true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.

Parameters:

  • nummeraanduiding_identificatie (String) —

    Identificatie van een nummeraanduiding uit de BAG. Deze is 16 cijfers lang.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.

Returns:

  • (Array<(AdresIOHal, Integer, Hash)>) —

    AdresIOHal data, response status code and response headers



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 214

def bevraag_adressen_met_num_id_with_http_info(nummeraanduiding_identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdresApi.bevraag_adressen_met_num_id ...'
  end
  # verify the required parameter 'nummeraanduiding_identificatie' is set
  if @api_client.config.client_side_validation && nummeraanduiding_identificatie.nil?
    fail ArgumentError, "Missing the required parameter 'nummeraanduiding_identificatie' when calling AdresApi.bevraag_adressen_met_num_id"
  end
  pattern = Regexp.new(/^[0-9]{16}$/)
  if @api_client.config.client_side_validation && nummeraanduiding_identificatie !~ pattern
    fail ArgumentError, "invalid value for 'nummeraanduiding_identificatie' when calling AdresApi.bevraag_adressen_met_num_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/adressen/{nummeraanduidingIdentificatie}'.sub('{' + 'nummeraanduidingIdentificatie' + '}', CGI.escape(nummeraanduiding_identificatie.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AdresIOHal'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyBAG']

  new_options = opts.merge(
    :operation => :"AdresApi.bevraag_adressen_met_num_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdresApi#bevraag_adressen_met_num_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#bevraag_adressen_with_http_info(opts = {}) ⇒ Array<(AdresIOHalCollection, Integer, Hash)>

Bevragen van huidige adressen met een (combinatie van) zoek parameters. De volgende bevragingen worden ondersteund: &lt;ol&gt; &lt;li&gt; Bevragen van één huidig adres met de identificatie van een zoekresultaat verkregen via /adressen/zoek. &lt;/li&gt; &lt;li&gt; Bevragen van één of meer huidige adressen met postcode, huisnummer en optioneel huisnummertoevoeging en huisletter. Parameter exacteMatch kan worden toegepast. &lt;/li&gt; &lt;li&gt; Bevragen van één of meer huidige adressen met de identificatie van een adresseerbaar object. &lt;/li&gt; &lt;li&gt; Bevragen van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en/of huisletter. Parameter exacteMatch kan worden toegepast. &lt;/li&gt; &lt;li&gt; Bevragen van één of meer huidige adressen met de identificatie van een pand. Expand wordt niet ondersteund. &lt;/li&gt; &lt;/ol&gt; Bij de bovenstaande bevragingen kunnen eveneens de volgende parameters worden gebruikt (tenzij anders vermeld):&lt;br/&gt; Als expand&#x3D;nummeraanduiding, openbareRuimte, woonplaats (of een combinatie daarvan) of als expand&#x3D;true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :zoekresultaat_identificatie (String) —

    De identificatie van een gekozen zoekresultaat uit de zoekResultatenHalCollectie verkregen bij een GET /adressen/zoek

  • :postcode (String) —

    Postcode behorende bij een nummeraanduiding.

  • :huisnummer (Integer) —

    Huisnummer behorende bij een nummeraanduiding.

  • :huisnummertoevoeging (String) —

    Huisnummertoevoeging behorende bij een nummeraanduiding.

  • :huisletter (String) —

    Huisletter behorende bij een nummeraanduiding.

  • :exacte_match (Boolean) —

    &quot;Een indicatie of de resultaten van een zoekoperatie exact overeen moeten komen met de zoekcriteria, zie [functionele specificatie exacte match](github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).&quot;

  • :adresseerbaar_object_identificatie (String) —

    Identificatie van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) uit de BAG.

  • :woonplaats_naam (String) —

    Naam van een woonplaats.

  • :openbare_ruimte_naam (String) —

    Naam van een openbare ruimte.

  • :pand_identificatie (String) —

    Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.

  • :expand (String) —

    Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.

  • :page (Integer) —

    Pagina nummer

  • :page_size (Integer) —

    Aantal resultaten per pagina

Returns:

  • (Array<(AdresIOHalCollection, Integer, Hash)>) —

    AdresIOHalCollection data, response status code and response headers



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 61

def bevraag_adressen_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdresApi.bevraag_adressen ...'
  end
  if @api_client.config.client_side_validation && !opts[:'zoekresultaat_identificatie'].nil? && opts[:'zoekresultaat_identificatie'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"zoekresultaat_identificatie"]" when calling AdresApi.bevraag_adressen, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'zoekresultaat_identificatie'].nil? && opts[:'zoekresultaat_identificatie'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"zoekresultaat_identificatie"]" when calling AdresApi.bevraag_adressen, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$/)
  if @api_client.config.client_side_validation && !opts[:'postcode'].nil? && opts[:'postcode'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"postcode\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'huisnummer'].nil? && opts[:'huisnummer'] > 99999
    fail ArgumentError, 'invalid value for "opts[:"huisnummer"]" when calling AdresApi.bevraag_adressen, must be smaller than or equal to 99999.'
  end

  if @api_client.config.client_side_validation && !opts[:'huisnummer'].nil? && opts[:'huisnummer'] < 1
    fail ArgumentError, 'invalid value for "opts[:"huisnummer"]" when calling AdresApi.bevraag_adressen, must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[0-9a-zA-Z]{1,4}$/)
  if @api_client.config.client_side_validation && !opts[:'huisnummertoevoeging'].nil? && opts[:'huisnummertoevoeging'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"huisnummertoevoeging\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^[a-zA-Z]{1}$/)
  if @api_client.config.client_side_validation && !opts[:'huisletter'].nil? && opts[:'huisletter'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"huisletter\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/)
  if @api_client.config.client_side_validation && !opts[:'adresseerbaar_object_identificatie'].nil? && opts[:'adresseerbaar_object_identificatie'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"adresseerbaar_object_identificatie\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'woonplaats_naam'].nil? && opts[:'woonplaats_naam'].to_s.length > 80
    fail ArgumentError, 'invalid value for "opts[:"woonplaats_naam"]" when calling AdresApi.bevraag_adressen, the character length must be smaller than or equal to 80.'
  end

  if @api_client.config.client_side_validation && !opts[:'woonplaats_naam'].nil? && opts[:'woonplaats_naam'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"woonplaats_naam"]" when calling AdresApi.bevraag_adressen, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^[\u0020-\u007E;\u00A0-\u00FF;\u0100-\u0113;\u0116-\u012B;\u012E-\u014D;\u0150-\u017E;\u02C7;\u02D8-\u02DB;\u02DD;\u2015;\u2018-\u2019;\u201C-\u201D;\u20AC;\u2122;\u2126;\u215B-\u215E;\u2190-\u2193;\u266A;]*/)
  if @api_client.config.client_side_validation && !opts[:'woonplaats_naam'].nil? && opts[:'woonplaats_naam'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"woonplaats_naam\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_naam'].nil? && opts[:'openbare_ruimte_naam'].to_s.length > 80
    fail ArgumentError, 'invalid value for "opts[:"openbare_ruimte_naam"]" when calling AdresApi.bevraag_adressen, the character length must be smaller than or equal to 80.'
  end

  if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_naam'].nil? && opts[:'openbare_ruimte_naam'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"openbare_ruimte_naam"]" when calling AdresApi.bevraag_adressen, the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/^[\u0020-\u007E;\u00A0-\u00FF;\u0100-\u0113;\u0116-\u012B;\u012E-\u014D;\u0150-\u017E;\u02C7;\u02D8-\u02DB;\u02DD;\u2015;\u2018-\u2019;\u201C-\u201D;\u20AC;\u2122;\u2126;\u215B-\u215E;\u2190-\u2193;\u266A;]*/)
  if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_naam'].nil? && opts[:'openbare_ruimte_naam'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"openbare_ruimte_naam\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^[0-9]{4}10[0-9]{10}$/)
  if @api_client.config.client_side_validation && !opts[:'pand_identificatie'].nil? && opts[:'pand_identificatie'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"pand_identificatie\"]' when calling AdresApi.bevraag_adressen, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdresApi.bevraag_adressen, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdresApi.bevraag_adressen, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 10
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdresApi.bevraag_adressen, must be greater than or equal to 10.'
  end

  # resource path
  local_var_path = '/adressen'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'zoekresultaatIdentificatie'] = opts[:'zoekresultaat_identificatie'] if !opts[:'zoekresultaat_identificatie'].nil?
  query_params[:'postcode'] = opts[:'postcode'] if !opts[:'postcode'].nil?
  query_params[:'huisnummer'] = opts[:'huisnummer'] if !opts[:'huisnummer'].nil?
  query_params[:'huisnummertoevoeging'] = opts[:'huisnummertoevoeging'] if !opts[:'huisnummertoevoeging'].nil?
  query_params[:'huisletter'] = opts[:'huisletter'] if !opts[:'huisletter'].nil?
  query_params[:'exacteMatch'] = opts[:'exacte_match'] if !opts[:'exacte_match'].nil?
  query_params[:'adresseerbaarObjectIdentificatie'] = opts[:'adresseerbaar_object_identificatie'] if !opts[:'adresseerbaar_object_identificatie'].nil?
  query_params[:'woonplaatsNaam'] = opts[:'woonplaats_naam'] if !opts[:'woonplaats_naam'].nil?
  query_params[:'openbareRuimteNaam'] = opts[:'openbare_ruimte_naam'] if !opts[:'openbare_ruimte_naam'].nil?
  query_params[:'pandIdentificatie'] = opts[:'pand_identificatie'] if !opts[:'pand_identificatie'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AdresIOHalCollection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyBAG']

  new_options = opts.merge(
    :operation => :"AdresApi.bevraag_adressen",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdresApi#bevraag_adressen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zoek(zoek, opts = {}) ⇒ ZoekResultaatHalCollection

Zoeken van huidige adressen Zoeken van huidige adressen met postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging. Een adres kan worden gevonden door de zoekresultaatidentificatie uit het antwoord als parameter mee te geven in get /adressen. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).

Parameters:

  • zoek (String) —

    Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Pagina nummer (default to 1)

  • :page_size (Integer) —

    Aantal resultaten per pagina (default to 20)

Returns:



275
276
277
278
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 275

def zoek(zoek, opts = {})
  data, _status_code, _headers = zoek_with_http_info(zoek, opts)
  data
end

#zoek_with_http_info(zoek, opts = {}) ⇒ Array<(ZoekResultaatHalCollection, Integer, Hash)>

Zoeken van huidige adressen Zoeken van huidige adressen met postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging. Een adres kan worden gevonden door de zoekresultaatidentificatie uit het antwoord als parameter mee te geven in get /adressen. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).

Parameters:

  • zoek (String) —

    Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Pagina nummer

  • :page_size (Integer) —

    Aantal resultaten per pagina

Returns:

  • (Array<(ZoekResultaatHalCollection, Integer, Hash)>) —

    ZoekResultaatHalCollection data, response status code and response headers



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/bag_kadaster_client/api/adres_api.rb', line 287

def zoek_with_http_info(zoek, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdresApi.zoek ...'
  end
  # verify the required parameter 'zoek' is set
  if @api_client.config.client_side_validation && zoek.nil?
    fail ArgumentError, "Missing the required parameter 'zoek' when calling AdresApi.zoek"
  end
  if @api_client.config.client_side_validation && zoek.to_s.length > 255
    fail ArgumentError, 'invalid value for "zoek" when calling AdresApi.zoek, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && zoek.to_s.length < 1
    fail ArgumentError, 'invalid value for "zoek" when calling AdresApi.zoek, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdresApi.zoek, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdresApi.zoek, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 10
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdresApi.zoek, must be greater than or equal to 10.'
  end

  # resource path
  local_var_path = '/adressen/zoek'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'zoek'] = zoek
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ZoekResultaatHalCollection'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyBAG']

  new_options = opts.merge(
    :operation => :"AdresApi.zoek",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdresApi#zoek\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end