Class: BagKadasterClient::AdresUitgebreidApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdresUitgebreidApi

Returns a new instance of AdresUitgebreidApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#bevraag_adres_uitgebreid_met_num_id(nummeraanduiding_identificatie, opts = {}) ⇒ AdresUitgebreidHal

Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding. Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.

Parameters:

  • nummeraanduiding_identificatie (String) —

    Identificatie van een nummeraanduiding uit de BAG.

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

    the optional parameters

Options Hash (opts):

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



28
29
30
31
 
# File 'lib/bag_kadaster_client/api/adres_uitgebreid_api.rb', line 28

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

#bevraag_adres_uitgebreid_met_num_id_with_http_info(nummeraanduiding_identificatie, opts = {}) ⇒ Array<(AdresUitgebreidHal, Integer, Hash)>

Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding. Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.

Parameters:

  • nummeraanduiding_identificatie (String) —

    Identificatie van een nummeraanduiding uit de 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<(AdresUitgebreidHal, Integer, Hash)>) —

    AdresUitgebreidHal data, response status code and response headers



39
40
41
42
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
 
# File 'lib/bag_kadaster_client/api/adres_uitgebreid_api.rb', line 39

def bevraag_adres_uitgebreid_met_num_id_with_http_info(nummeraanduiding_identificatie, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id ...'
  end
  # verify the required parameter 'nummeraanduiding_identificatie' is set
  if @api_client.config.client_side_validation && nummeraanduiding_identificatie.nil?
    fail ArgumentError, "Missing the required parameter 'nummeraanduiding_identificatie' when calling AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id"
  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 AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id, 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 = '/adressenuitgebreid/{nummeraanduidingIdentificatie}'.sub('{' + 'nummeraanduidingIdentificatie' + '}', CGI.escape(nummeraanduiding_identificatie.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] || 'AdresUitgebreidHal'

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

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

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

#zoek_adres_uitgebreid(opts = {}) ⇒ AdresUitgebreidHalCollection

Bevragen van de uitgebreide informatie van één of meer huidige adressen op basis van verschillende combinaties van parameters. De volgende (combinaties van) parameters worden ondersteund: <ol> <li>Bevragen van de uitgebreide informatie van één of meer huidige adressen met een postcode, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. </li> <li>Bevragen van de uitgebreide informatie van één of meer huidige adressen met de identificatie van een adresseerbaar object.</li> <li>Bevragen van de uitgebreide informatie van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. </li> </ol>

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)."; (default to false)

  • :adresseerbaar_object_identificatie (String) —

    Identificatie van een adresseerbaar object uit de BAG.

  • :woonplaats_naam (String) —

    Naam van een woonplaats.

  • :openbare_ruimte_naam (String) —

    Naam van een openbare ruimte.

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



110
111
112
113
 
# File 'lib/bag_kadaster_client/api/adres_uitgebreid_api.rb', line 110

def zoek_adres_uitgebreid(opts = {})
  data, _status_code, _headers = zoek_adres_uitgebreid_with_http_info(opts)
  data
end

#zoek_adres_uitgebreid_with_http_info(opts = {}) ⇒ Array<(AdresUitgebreidHalCollection, Integer, Hash)>

Bevragen van de uitgebreide informatie van één of meer huidige adressen op basis van verschillende combinaties van parameters. De volgende (combinaties van) parameters worden ondersteund: &lt;ol&gt; &lt;li&gt;Bevragen van de uitgebreide informatie van één of meer huidige adressen met een postcode, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. &lt;/li&gt; &lt;li&gt;Bevragen van de uitgebreide informatie van één of meer huidige adressen met de identificatie van een adresseerbaar object.&lt;/li&gt; &lt;li&gt;Bevragen van de uitgebreide informatie van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. &lt;/li&gt; &lt;/ol&gt;

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).";

  • :adresseerbaar_object_identificatie (String) —

    Identificatie van een adresseerbaar object uit de BAG.

  • :woonplaats_naam (String) —

    Naam van een woonplaats.

  • :openbare_ruimte_naam (String) —

    Naam van een openbare ruimte.

  • :accept_crs (String) —

    Gewenste CRS van de coördinaten in de response.

Returns:



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
197
198
199
200
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
 
# File 'lib/bag_kadaster_client/api/adres_uitgebreid_api.rb', line 128

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

  pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/)
  if @api_client.config.client_side_validation && !opts[:'adresseerbaar_object_identificatie'].nil? && opts[:'adresseerbaar_object_identificatie'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"adresseerbaar_object_identificatie\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, 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 AdresUitgebreidApi.zoek_adres_uitgebreid, 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 AdresUitgebreidApi.zoek_adres_uitgebreid, 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 AdresUitgebreidApi.zoek_adres_uitgebreid, 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 AdresUitgebreidApi.zoek_adres_uitgebreid, 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 AdresUitgebreidApi.zoek_adres_uitgebreid, 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 AdresUitgebreidApi.zoek_adres_uitgebreid, 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 = '/adressenuitgebreid'

  # 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[:'adresseerbaarObjectIdentificatie'] = opts[:'adresseerbaar_object_identificatie'] if !opts[:'adresseerbaar_object_identificatie'].nil?
  query_params[:'woonplaatsNaam'] = opts[:'woonplaats_naam'] if !opts[:'woonplaats_naam'].nil?
  query_params[:'openbareRuimteNaam'] = opts[:'openbare_ruimte_naam'] if !opts[:'openbare_ruimte_naam'].nil?

  # 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] || 'AdresUitgebreidHalCollection'

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

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