Class: BagKadasterClient::WoonplaatsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WoonplaatsApi

Returns a new instance of WoonplaatsApi.



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

def api_client
  @api_client
end

Instance Method Details

#woonplaats_geometrie(point, opts = {}) ⇒ WoonplaatsIOHalCollection

bevragen van een woonplaats met een geometrische locatie. Bevragen/raadplegen van een voorkomen van een Woonplaats met een geometrische locatie. Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • point (Point) —

    Geometrisch punt waarop de woonplaatsen bepaald moeten worden.

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum 'YYYY-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.

  • :huidig (Boolean) —

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

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

  • :content_crs (String) —

    CRS van de meegegeven geometrie.

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



33
34
35
36
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 33

def woonplaats_geometrie(point, opts = {})
  data, _status_code, _headers = woonplaats_geometrie_with_http_info(point, opts)
  data
end

#woonplaats_geometrie_with_http_info(point, opts = {}) ⇒ Array<(WoonplaatsIOHalCollection, Integer, Hash)>

bevragen van een woonplaats met een geometrische locatie. Bevragen/raadplegen van een voorkomen van een Woonplaats met een geometrische locatie. Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • point (Point) —

    Geometrisch punt waarop de woonplaatsen bepaald moeten worden.

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; 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.

  • :huidig (Boolean) —

    Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.

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

  • :content_crs (String) —

    CRS van de meegegeven geometrie.

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:

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

    WoonplaatsIOHalCollection data, response status code and response headers



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
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 49

def woonplaats_geometrie_with_http_info(point, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WoonplaatsApi.woonplaats_geometrie ...'
  end
  # verify the required parameter 'point' is set
  if @api_client.config.client_side_validation && point.nil?
    fail ArgumentError, "Missing the required parameter 'point' when calling WoonplaatsApi.woonplaats_geometrie"
  end
  allowable_values = ["epsg:28992"]
  if @api_client.config.client_side_validation && opts[:'content_crs'] && !allowable_values.include?(opts[:'content_crs'])
    fail ArgumentError, "invalid value for \"content_crs\", must be one of #{allowable_values}"
  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 = '/woonplaatsen'

  # 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[:'huidig'] = opts[:'huidig'] if !opts[:'huidig'].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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'Content-Crs'] = opts[:'content_crs'] if !opts[:'content_crs'].nil?
  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] || @api_client.object_to_http_body(point)

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

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

  new_options = opts.merge(
    :operation => :"WoonplaatsApi.woonplaats_geometrie",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WoonplaatsApi#woonplaats_geometrie\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#woonplaats_identificatie(identificatie, opts = {}) ⇒ WoonplaatsIOHal

bevragen van een woonplaats met de identificatie van een woonplaats. Bevragen/raadplegen van een voorkomen van een Woonplaats met de identificatie van de woonplaats. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

    De identificatie van een BAG object. Deze is 4 cijfers lang bij een woonplaats.

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; 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:



125
126
127
128
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 125

def woonplaats_identificatie(identificatie, opts = {})
  data, _status_code, _headers = woonplaats_identificatie_with_http_info(identificatie, opts)
  data
end

#woonplaats_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts = {}) ⇒ WoonplaatsIOHal

bevragen van een voorkomen van een woonplaats met de identificatie van een woonplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG. Bevragen/raadplegen van een voorkomen van een Woonplaats met de identificatie van een woonplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG. Als expand=bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

    De identificatie van een BAG object. Deze is 4 cijfers lang bij een woonplaats.

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

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



209
210
211
212
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 209

def woonplaats_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts = {})
  data, _status_code, _headers = woonplaats_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
  data
end

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

bevragen van een voorkomen van een woonplaats met de identificatie van een woonplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG. Bevragen/raadplegen van een voorkomen van een Woonplaats met de identificatie van een woonplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG. Als expand&#x3D;bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

    De identificatie van een BAG object. Deze is 4 cijfers lang bij een woonplaats.

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

  • :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<(WoonplaatsIOHal, Integer, Hash)>) —

    WoonplaatsIOHal data, response status code and response headers



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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 223

def woonplaats_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WoonplaatsApi.woonplaats_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 WoonplaatsApi.woonplaats_identificatie_voorkomen"
  end
  pattern = Regexp.new(/[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}/)
  if @api_client.config.client_side_validation && identificatie !~ pattern
    fail ArgumentError, "invalid value for 'identificatie' when calling WoonplaatsApi.woonplaats_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 WoonplaatsApi.woonplaats_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 WoonplaatsApi.woonplaats_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 WoonplaatsApi.woonplaats_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 = '/woonplaatsen/{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] || {}
  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] || 'WoonplaatsIOHal'

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

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

#woonplaats_identificatie_with_http_info(identificatie, opts = {}) ⇒ Array<(WoonplaatsIOHal, Integer, Hash)>

bevragen van een woonplaats met de identificatie van een woonplaats. Bevragen/raadplegen van een voorkomen van een Woonplaats met de identificatie van de woonplaats. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

    De identificatie van een BAG object. Deze is 4 cijfers lang bij een woonplaats.

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; 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<(WoonplaatsIOHal, Integer, Hash)>) —

    WoonplaatsIOHal data, response status code and response headers



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
197
198
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 139

def woonplaats_identificatie_with_http_info(identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WoonplaatsApi.woonplaats_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 WoonplaatsApi.woonplaats_identificatie"
  end
  pattern = Regexp.new(/[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}/)
  if @api_client.config.client_side_validation && identificatie !~ pattern
    fail ArgumentError, "invalid value for 'identificatie' when calling WoonplaatsApi.woonplaats_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 = '/woonplaatsen/{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] || 'WoonplaatsIOHal'

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

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

#woonplaats_lvc_identificatie(identificatie, opts = {}) ⇒ WoonplaatsIOLvcHalCollection

bevragen van de levenscyclus van een woonplaats met de identificatie van een woonplaats. Bevragen/raadplegen van de levenscyclus van een Woonplaats met de identificatie van de woonplaats. Als expand=bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

    De identificatie van een BAG object. Deze is 4 cijfers lang bij een woonplaats.

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

    the optional parameters

Options Hash (opts):

  • :gehele_lvc (Boolean) —

    Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd. Als deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false). Voor een toelichting zie de [Praktijkhandleiding BAG](imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens). (default to false)

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



303
304
305
306
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 303

def woonplaats_lvc_identificatie(identificatie, opts = {})
  data, _status_code, _headers = woonplaats_lvc_identificatie_with_http_info(identificatie, opts)
  data
end

#woonplaats_lvc_identificatie_with_http_info(identificatie, opts = {}) ⇒ Array<(WoonplaatsIOLvcHalCollection, Integer, Hash)>

bevragen van de levenscyclus van een woonplaats met de identificatie van een woonplaats. Bevragen/raadplegen van de levenscyclus van een Woonplaats met de identificatie van de woonplaats. Als expand&#x3D;bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • identificatie (String) —

    De identificatie van een BAG object. Deze is 4 cijfers lang bij een woonplaats.

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

    the optional parameters

Options Hash (opts):

  • :gehele_lvc (Boolean) —

    Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd. Als deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false). Voor een toelichting zie de [Praktijkhandleiding BAG](imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens).

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



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
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 316

def woonplaats_lvc_identificatie_with_http_info(identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WoonplaatsApi.woonplaats_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 WoonplaatsApi.woonplaats_lvc_identificatie"
  end
  pattern = Regexp.new(/[0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]|[0-9][1-9][0-9]{2}|[1-9][0-9]{3}/)
  if @api_client.config.client_side_validation && identificatie !~ pattern
    fail ArgumentError, "invalid value for 'identificatie' when calling WoonplaatsApi.woonplaats_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 = '/woonplaatsen/{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?
  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] || 'WoonplaatsIOLvcHalCollection'

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

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

#woonplaats_naam(naam, opts = {}) ⇒ WoonplaatsIOHalCollection

bevragen van één of meer woonplaatsen met een woonplaatsnaam. Bevragen/raadplegen van één voorkomen van één of meer woonplaatsen met een woonplaatsnaam. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • naam (String) —

    Naam van een woonplaats object uit de BAG.

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; 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:



385
386
387
388
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 385

def woonplaats_naam(naam, opts = {})
  data, _status_code, _headers = woonplaats_naam_with_http_info(naam, opts)
  data
end

#woonplaats_naam_with_http_info(naam, opts = {}) ⇒ Array<(WoonplaatsIOHalCollection, Integer, Hash)>

bevragen van één of meer woonplaatsen met een woonplaatsnaam. Bevragen/raadplegen van één voorkomen van één of meer woonplaatsen met een woonplaatsnaam. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;bronhouders, geometrie of true dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.

Parameters:

  • naam (String) —

    Naam van een woonplaats object uit de BAG.

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

    the optional parameters

Options Hash (opts):

  • :geldig_op (Date) —

    Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; 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<(WoonplaatsIOHalCollection, Integer, Hash)>) —

    WoonplaatsIOHalCollection data, response status code and response headers



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/bag_kadaster_client/api/woonplaats_api.rb', line 399

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

  if @api_client.config.client_side_validation && naam.to_s.length < 1
    fail ArgumentError, 'invalid value for "naam" when calling WoonplaatsApi.woonplaats_naam, 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 && naam !~ pattern
    fail ArgumentError, "invalid value for 'naam' when calling WoonplaatsApi.woonplaats_naam, 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 = '/woonplaatsen'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'naam'] = naam
  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] || 'WoonplaatsIOHalCollection'

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

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