Class: BagKadasterClient::NummeraanduidingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NummeraanduidingApi

Returns a new instance of NummeraanduidingApi.



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

def api_client
  @api_client
end

Instance Method Details

#nummeraanduiding_identificatie(nummeraanduiding_identificatie, opts = {}) ⇒ NummeraanduidingIOHal

bevragen van een nummeraanduiding op basis van de identificatie van een nummeraanduiding Bevragen/raadplegen van één nummeraanduiding met de identificatie van een nummeraanduiding. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=ligtInWoonplaats, ligtAanOpenbareRuimte of als expand=true dan worden de gevraagde of alle gerelateerde objecten als geneste resources geleverd.

Parameters:

  • nummeraanduiding_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 '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.

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



30
31
32
33
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 30

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

#nummeraanduiding_identificatie_voorkomen(nummeraanduiding_identificatie, versie, timestamp_registratie_lv, opts = {}) ⇒ NummeraanduidingIOHal

bevragen van een voorkomen van een nummeraanduiding, op basis van de identificatie van een nummeraanduiding 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 nummeraanduiding met de identificatie van een nummeraanduiding en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.

Parameters:

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

Returns:



106
107
108
109
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 106

def nummeraanduiding_identificatie_voorkomen(nummeraanduiding_identificatie, versie, timestamp_registratie_lv, opts = {})
  data, _status_code, _headers = nummeraanduiding_identificatie_voorkomen_with_http_info(nummeraanduiding_identificatie, versie, timestamp_registratie_lv, opts)
  data
end

#nummeraanduiding_identificatie_voorkomen_with_http_info(nummeraanduiding_identificatie, versie, timestamp_registratie_lv, opts = {}) ⇒ Array<(NummeraanduidingIOHal, Integer, Hash)>

bevragen van een voorkomen van een nummeraanduiding, op basis van de identificatie van een nummeraanduiding 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 nummeraanduiding met de identificatie van een nummeraanduiding en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.

Parameters:

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

Returns:

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

    NummeraanduidingIOHal data, response status code and response headers



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

def nummeraanduiding_identificatie_voorkomen_with_http_info(nummeraanduiding_identificatie, versie, timestamp_registratie_lv, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NummeraanduidingApi.nummeraanduiding_identificatie_voorkomen ...'
  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 NummeraanduidingApi.nummeraanduiding_identificatie_voorkomen"
  end
  pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
  if @api_client.config.client_side_validation && nummeraanduiding_identificatie !~ pattern
    fail ArgumentError, "invalid value for 'nummeraanduiding_identificatie' when calling NummeraanduidingApi.nummeraanduiding_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 NummeraanduidingApi.nummeraanduiding_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 NummeraanduidingApi.nummeraanduiding_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 NummeraanduidingApi.nummeraanduiding_identificatie_voorkomen, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/nummeraanduidingen/{nummeraanduidingIdentificatie}/{versie}/{timestampRegistratieLv}'.sub('{' + 'nummeraanduidingIdentificatie' + '}', CGI.escape(nummeraanduiding_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'])

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

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

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

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

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

#nummeraanduiding_identificatie_with_http_info(nummeraanduiding_identificatie, opts = {}) ⇒ Array<(NummeraanduidingIOHal, Integer, Hash)>

bevragen van een nummeraanduiding op basis van de identificatie van een nummeraanduiding Bevragen/raadplegen van één nummeraanduiding met de identificatie van een nummeraanduiding. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;ligtInWoonplaats, ligtAanOpenbareRuimte of als expand&#x3D;true dan worden de gevraagde of alle gerelateerde objecten als geneste resources geleverd.

Parameters:

  • nummeraanduiding_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 &#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.

Returns:

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

    NummeraanduidingIOHal data, response status code and response headers



43
44
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
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 43

def nummeraanduiding_identificatie_with_http_info(nummeraanduiding_identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NummeraanduidingApi.nummeraanduiding_identificatie ...'
  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 NummeraanduidingApi.nummeraanduiding_identificatie"
  end
  pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
  if @api_client.config.client_side_validation && nummeraanduiding_identificatie !~ pattern
    fail ArgumentError, "invalid value for 'nummeraanduiding_identificatie' when calling NummeraanduidingApi.nummeraanduiding_identificatie, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/nummeraanduidingen/{nummeraanduidingIdentificatie}'.sub('{' + 'nummeraanduidingIdentificatie' + '}', CGI.escape(nummeraanduiding_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'])

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

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

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

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

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

#nummeraanduiding_lvc_identificatie(nummeraanduiding_identificatie, opts = {}) ⇒ NummeraanduidingIOLvcHalCollection

bevragen levenscyclus van een nummeraanduiding met de identificatie van een nummeraanduiding. Bevragen/raadplegen van de levenscyclus van één nummeraanduiding met de identificatie van een nummeraanduiding.

Parameters:

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



190
191
192
193
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 190

def nummeraanduiding_lvc_identificatie(nummeraanduiding_identificatie, opts = {})
  data, _status_code, _headers = nummeraanduiding_lvc_identificatie_with_http_info(nummeraanduiding_identificatie, opts)
  data
end

#nummeraanduiding_lvc_identificatie_with_http_info(nummeraanduiding_identificatie, opts = {}) ⇒ Array<(NummeraanduidingIOLvcHalCollection, Integer, Hash)>

bevragen levenscyclus van een nummeraanduiding met de identificatie van een nummeraanduiding. Bevragen/raadplegen van de levenscyclus van één nummeraanduiding met de identificatie van een nummeraanduiding.

Parameters:

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



201
202
203
204
205
206
207
208
209
210
211
212
213
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
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 201

def nummeraanduiding_lvc_identificatie_with_http_info(nummeraanduiding_identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NummeraanduidingApi.nummeraanduiding_lvc_identificatie ...'
  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 NummeraanduidingApi.nummeraanduiding_lvc_identificatie"
  end
  pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
  if @api_client.config.client_side_validation && nummeraanduiding_identificatie !~ pattern
    fail ArgumentError, "invalid value for 'nummeraanduiding_identificatie' when calling NummeraanduidingApi.nummeraanduiding_lvc_identificatie, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/nummeraanduidingen/{nummeraanduidingIdentificatie}/lvc'.sub('{' + 'nummeraanduidingIdentificatie' + '}', CGI.escape(nummeraanduiding_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'])

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

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

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

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

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

#zoek_nummeraanduiding(opts = {}) ⇒ NummeraanduidingIOHalCollection

bevragen nummeraanduiding(en) op basis van verschillende combinaties van parameters. De volgende (combinaties van) parameters worden ondersteund: 1. Bevragen/raadplegen van een (collectie van) nummeraanduiding(en) met postcode en huisnummer (evt. met huisletter en huisnummertoevoeging). 2. Bevragen/raadplegen van een (collectie van) nummeraanduiding(en) met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter. 3. Bevragen/zoeken van alle aan een openbare ruimte gerelateerde nummeraanduidingen met een openbare ruimte identificatie. Expand wordt niet ondersteund. 4. Bevragen/zoeken van nummeraanduidingen met een pand identificatie. Expand wordt niet ondersteund. Bij de bovenstaande bevragingen kunnen (tenzij anders vermeld) de volgende parameters worden gebruikt: geldigOp, beschikbaarOp, huidig, page en pageSize. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature). Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Parameter huidig kan worden toegepast. Als expand=ligtInWoonplaats, ligtAanOpenbareRuimte of als expand=true dan worden de gevraagde of alle gerelateerde objecten als geneste resources geleverd. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :woonplaats_naam (String) —

    Naam van een woonplaats.

  • :openbare_ruimte_naam (String) —

    Naam van een openbare ruimte.

  • :openbare_ruimte_identificatie (String) —

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

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

  • :page (Integer) —

    Pagina nummer (default to 1)

  • :page_size (Integer) —

    Aantal resultaten per pagina (default to 20)

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

  • :pand_identificatie (String) —

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

Returns:



274
275
276
277
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 274

def zoek_nummeraanduiding(opts = {})
  data, _status_code, _headers = zoek_nummeraanduiding_with_http_info(opts)
  data
end

#zoek_nummeraanduiding_with_http_info(opts = {}) ⇒ Array<(NummeraanduidingIOHalCollection, Integer, Hash)>

bevragen nummeraanduiding(en) op basis van verschillende combinaties van parameters. De volgende (combinaties van) parameters worden ondersteund: 1. Bevragen/raadplegen van een (collectie van) nummeraanduiding(en) met postcode en huisnummer (evt. met huisletter en huisnummertoevoeging). 2. Bevragen/raadplegen van een (collectie van) nummeraanduiding(en) met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter. 3. Bevragen/zoeken van alle aan een openbare ruimte gerelateerde nummeraanduidingen met een openbare ruimte identificatie. Expand wordt niet ondersteund. 4. Bevragen/zoeken van nummeraanduidingen met een pand identificatie. Expand wordt niet ondersteund. Bij de bovenstaande bevragingen kunnen (tenzij anders vermeld) de volgende parameters worden gebruikt: geldigOp, beschikbaarOp, huidig, page en pageSize. Voor paginering, zie: [functionele specificatie paginering](github.com/lvbag/BAG-API/blob/master/Features/paginering.feature). Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Parameter huidig kan worden toegepast. Als expand&#x3D;ligtInWoonplaats, ligtAanOpenbareRuimte of als expand&#x3D;true dan worden de gevraagde of alle gerelateerde objecten als geneste resources geleverd. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • :woonplaats_naam (String) —

    Naam van een woonplaats.

  • :openbare_ruimte_naam (String) —

    Naam van een openbare ruimte.

  • :openbare_ruimte_identificatie (String) —

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

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

  • :page (Integer) —

    Pagina nummer

  • :page_size (Integer) —

    Aantal resultaten per pagina

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

  • :pand_identificatie (String) —

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

Returns:



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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
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
 
# File 'lib/bag_kadaster_client/api/nummeraanduiding_api.rb', line 298

def zoek_nummeraanduiding_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NummeraanduidingApi.zoek_nummeraanduiding ...'
  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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^[0-9]{4}30[0-9]{10}$/)
  if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_identificatie'].nil? && opts[:'openbare_ruimte_identificatie'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"openbare_ruimte_identificatie\"]' when calling NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, 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 NummeraanduidingApi.zoek_nummeraanduiding, must be greater than or equal to 10.'
  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 NummeraanduidingApi.zoek_nummeraanduiding, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/nummeraanduidingen'

  # query parameters
  query_params = opts[:query_params] || {}
  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[:'woonplaatsNaam'] = opts[:'woonplaats_naam'] if !opts[:'woonplaats_naam'].nil?
  query_params[:'openbareRuimteNaam'] = opts[:'openbare_ruimte_naam'] if !opts[:'openbare_ruimte_naam'].nil?
  query_params[:'openbareRuimteIdentificatie'] = opts[:'openbare_ruimte_identificatie'] if !opts[:'openbare_ruimte_identificatie'].nil?
  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?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'pandIdentificatie'] = opts[:'pand_identificatie'] if !opts[:'pand_identificatie'].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] || 'NummeraanduidingIOHalCollection'

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

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