Class: BagKadasterClient::VerblijfsobjectApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VerblijfsobjectApi

Returns a new instance of VerblijfsobjectApi.



19
20
21
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_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/verblijfsobject_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#verblijfsobject_identificatie(identificatie, opts = {}) ⇒ VerblijfsobjectIOHal

bevragen 1 verblijfsobject met de identificatie van een verblijfsobject. Bevragen/raadplegen van één voorkomen van een Verblijfsobject met de identificatie van een verblijfsobject. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan of true, dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD` Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :beschikbaar_op (Time) —

    Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd `YYYY-MM-DDThh:mm:ss.sss' Hierin kunnen de seconden ':ss' en milliseconden '.sss' of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde ':00' respectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 cijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :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.

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



31
32
33
34
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 31

def verblijfsobject_identificatie(identificatie, opts = {})
  data, _status_code, _headers = verblijfsobject_identificatie_with_http_info(identificatie, opts)
  data
end

#verblijfsobject_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts = {}) ⇒ VerblijfsobjectIOHal

bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen Bevragen/raadplegen van een voorkomen van een verblijfsobject, met de identificatie van een verblijfsobject en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.

Parameters:

  • identificatie (String) —

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

  • versie (Integer) —

    De versie van een voorkomen van een object

  • timestamp_registratie_lv (String) —

    Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG

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

    the optional parameters

Options Hash (opts):

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



114
115
116
117
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 114

def verblijfsobject_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts = {})
  data, _status_code, _headers = verblijfsobject_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
  data
end

#verblijfsobject_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts = {}) ⇒ Array<(VerblijfsobjectIOHal, Integer, Hash)>

bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen Bevragen/raadplegen van een voorkomen van een verblijfsobject, met de identificatie van een verblijfsobject en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.

Parameters:

  • identificatie (String) —

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

  • versie (Integer) —

    De versie van een voorkomen van een object

  • timestamp_registratie_lv (String) —

    Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG

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

    the optional parameters

Options Hash (opts):

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:

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

    VerblijfsobjectIOHal data, response status code and response headers



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
196
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 127

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

  # verify the required parameter 'versie' is set
  if @api_client.config.client_side_validation && versie.nil?
    fail ArgumentError, "Missing the required parameter 'versie' when calling VerblijfsobjectApi.verblijfsobject_identificatie_voorkomen"
  end
  # verify the required parameter 'timestamp_registratie_lv' is set
  if @api_client.config.client_side_validation && timestamp_registratie_lv.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp_registratie_lv' when calling VerblijfsobjectApi.verblijfsobject_identificatie_voorkomen"
  end
  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && timestamp_registratie_lv !~ pattern
    fail ArgumentError, "invalid value for 'timestamp_registratie_lv' when calling VerblijfsobjectApi.verblijfsobject_identificatie_voorkomen, must conform to the pattern #{pattern}."
  end

  allowable_values = ["epsg:28992"]
  if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
    fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/verblijfsobjecten/{identificatie}/{versie}/{timestampRegistratieLv}'.sub('{' + 'identificatie' + '}', CGI.escape(identificatie.to_s)).sub('{' + 'versie' + '}', CGI.escape(versie.to_s)).sub('{' + 'timestampRegistratieLv' + '}', CGI.escape(timestamp_registratie_lv.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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'])
  header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"VerblijfsobjectApi.verblijfsobject_identificatie_voorkomen",
    :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: VerblijfsobjectApi#verblijfsobject_identificatie_voorkomen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verblijfsobject_identificatie_with_http_info(identificatie, opts = {}) ⇒ Array<(VerblijfsobjectIOHal, Integer, Hash)>

bevragen 1 verblijfsobject met de identificatie van een verblijfsobject. Bevragen/raadplegen van één voorkomen van een Verblijfsobject met de identificatie van een verblijfsobject. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan of true, dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#x60;JJJJ-MM-DD&#x60; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :beschikbaar_op (Time) —

    Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39; Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :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.

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:

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

    VerblijfsobjectIOHal data, response status code and response headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 45

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

  allowable_values = ["epsg:28992"]
  if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
    fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/verblijfsobjecten/{identificatie}'.sub('{' + 'identificatie' + '}', CGI.escape(identificatie.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'geldigOp'] = opts[:'geldig_op'] if !opts[:'geldig_op'].nil?
  query_params[:'beschikbaarOp'] = opts[:'beschikbaar_op'] if !opts[:'beschikbaar_op'].nil?
  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'])
  header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"VerblijfsobjectApi.verblijfsobject_identificatie",
    :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: VerblijfsobjectApi#verblijfsobject_identificatie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verblijfsobject_lvc_identificatie(identificatie, opts = {}) ⇒ VerblijfsobjectIOLvcHalCollection

bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject. Bevragen/raadplegen van de levenscyclus van een Verblijfsobject met de identificatie van de verblijfsobject.

Parameters:

  • identificatie (String) —

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

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

    the optional parameters

Options Hash (opts):

Returns:



205
206
207
208
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 205

def verblijfsobject_lvc_identificatie(identificatie, opts = {})
  data, _status_code, _headers = verblijfsobject_lvc_identificatie_with_http_info(identificatie, opts)
  data
end

#verblijfsobject_lvc_identificatie_with_http_info(identificatie, opts = {}) ⇒ Array<(VerblijfsobjectIOLvcHalCollection, Integer, Hash)>

bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject. Bevragen/raadplegen van de levenscyclus van een Verblijfsobject met de identificatie van de verblijfsobject.

Parameters:

  • identificatie (String) —

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

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

    the optional parameters

Options Hash (opts):

Returns:



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
267
268
269
270
271
272
273
274
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 217

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

  allowable_values = ["epsg:28992"]
  if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
    fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/verblijfsobjecten/{identificatie}/lvc'.sub('{' + 'identificatie' + '}', CGI.escape(identificatie.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'geheleLvc'] = opts[:'gehele_lvc'] if !opts[:'gehele_lvc'].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'])
  header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"VerblijfsobjectApi.verblijfsobject_lvc_identificatie",
    :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: VerblijfsobjectApi#verblijfsobject_lvc_identificatie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#zoek_verblijfsobjecten(pand_identificatie, opts = {}) ⇒ VerblijfsobjectIOHalCollection

bevragen van alle aan een pand gerelateerde verblijfsobjecten (met paginering). Bevragen/zoeken van alle aan een pand gerelateerde verblijfsobjecten, met een pand identificatie en met paginering. Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).

Parameters:

  • pand_identificatie (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :huidig (Boolean) —

    Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn. (default to false)

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#x60;JJJJ-MM-DD&#x60; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :beschikbaar_op (Time) —

    Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39; Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :page (Integer) —

    Pagina nummer (default to 1)

  • :page_size (Integer) —

    Aantal resultaten per pagina (default to 20)

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



287
288
289
290
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 287

def zoek_verblijfsobjecten(pand_identificatie, opts = {})
  data, _status_code, _headers = zoek_verblijfsobjecten_with_http_info(pand_identificatie, opts)
  data
end

#zoek_verblijfsobjecten_with_http_info(pand_identificatie, opts = {}) ⇒ Array<(VerblijfsobjectIOHalCollection, Integer, Hash)>

bevragen van alle aan een pand gerelateerde verblijfsobjecten (met paginering). Bevragen/zoeken van alle aan een pand gerelateerde verblijfsobjecten, met een pand identificatie en met paginering. Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).

Parameters:

  • pand_identificatie (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :huidig (Boolean) —

    Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#x60;JJJJ-MM-DD&#x60; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :beschikbaar_op (Time) —

    Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39; Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.

  • :page (Integer) —

    Pagina nummer

  • :page_size (Integer) —

    Aantal resultaten per pagina

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/bag_kadaster_client/api/verblijfsobject_api.rb', line 303

def zoek_verblijfsobjecten_with_http_info(pand_identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VerblijfsobjectApi.zoek_verblijfsobjecten ...'
  end
  # verify the required parameter 'pand_identificatie' is set
  if @api_client.config.client_side_validation && pand_identificatie.nil?
    fail ArgumentError, "Missing the required parameter 'pand_identificatie' when calling VerblijfsobjectApi.zoek_verblijfsobjecten"
  end
  pattern = Regexp.new(/^[0-9]{4}10[0-9]{10}$/)
  if @api_client.config.client_side_validation && pand_identificatie !~ pattern
    fail ArgumentError, "invalid value for 'pand_identificatie' when calling VerblijfsobjectApi.zoek_verblijfsobjecten, 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 VerblijfsobjectApi.zoek_verblijfsobjecten, 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 VerblijfsobjectApi.zoek_verblijfsobjecten, 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 VerblijfsobjectApi.zoek_verblijfsobjecten, must be greater than or equal to 10.'
  end

  allowable_values = ["epsg:28992"]
  if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
    fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/verblijfsobjecten'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pandIdentificatie'] = pand_identificatie
  query_params[:'huidig'] = opts[:'huidig'] if !opts[:'huidig'].nil?
  query_params[:'geldigOp'] = opts[:'geldig_op'] if !opts[:'geldig_op'].nil?
  query_params[:'beschikbaarOp'] = opts[:'beschikbaar_op'] if !opts[:'beschikbaar_op'].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'])
  header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"VerblijfsobjectApi.zoek_verblijfsobjecten",
    :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: VerblijfsobjectApi#zoek_verblijfsobjecten\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end