Class: BagKadasterClient::BronhouderApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BronhouderApi

Returns a new instance of BronhouderApi.



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

def api_client
  @api_client
end

Instance Method Details

#bevragen_bronhouder(identificatie, opts = {}) ⇒ BronhouderHal

Bevragen bronhouder met de bronhouder identificatie (gemeentecode). Bevragen/raadplegen van een bronhouder met de identificatie van een bronhouder (gemeentecode). Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd.

Parameters:

  • identificatie (String) —

    Een officiële code die aan een gemeente is toegekend, ontleend is aan tabel 33.

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

Returns:



29
30
31
32
 
# File 'lib/bag_kadaster_client/api/bronhouder_api.rb', line 29

def bevragen_bronhouder(identificatie, opts = {})
  data, _status_code, _headers = bevragen_bronhouder_with_http_info(identificatie, opts)
  data
end

#bevragen_bronhouder_with_http_info(identificatie, opts = {}) ⇒ Array<(BronhouderHal, Integer, Hash)>

Bevragen bronhouder met de bronhouder identificatie (gemeentecode). Bevragen/raadplegen van een bronhouder met de identificatie van een bronhouder (gemeentecode). Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd.

Parameters:

  • identificatie (String) —

    Een officiële code die aan een gemeente is toegekend, ontleend is aan tabel 33.

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

Returns:

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

    BronhouderHal data, response status code and response headers



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

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

  # resource path
  local_var_path = '/bronhouders/{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?

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

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

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

#bronhouder_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts = {}) ⇒ BronhouderHal

bevragen voorkomen van een bronhouder met de identificatie van een bronhouder 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 bronhouder met de identificatie van een bronhouder 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) —

    Een officiële code die aan een gemeente is toegekend, ontleend is aan tabel 33.

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



103
104
105
106
 
# File 'lib/bag_kadaster_client/api/bronhouder_api.rb', line 103

def bronhouder_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts = {})
  data, _status_code, _headers = bronhouder_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
  data
end

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

bevragen voorkomen van een bronhouder met de identificatie van een bronhouder 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 bronhouder met de identificatie van een bronhouder 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) —

    Een officiële code die aan een gemeente is toegekend, ontleend is aan tabel 33.

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

    BronhouderHal data, response status code and response headers



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/bag_kadaster_client/api/bronhouder_api.rb', line 115

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

  # resource path
  local_var_path = '/bronhouders/{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'])

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

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

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

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

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

#zoek_bronhouder(opts = {}) ⇒ BronhouderHalCollection

Bevragen bronhouder met een object identificatie. Bevragen/raadplegen van een bronhouder met de identificatie van een object. De identificatie van één van de objecten: woonplaats, openbare ruimte, nummeraanduiding, ligplaats, standplaats, verblijfsobject of pand dient gespecificeerd te worden:<br/> Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :woonplaats_identificatie (String) —

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

  • :object_identificatie (String) —

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

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

Returns:



189
190
191
192
 
# File 'lib/bag_kadaster_client/api/bronhouder_api.rb', line 189

def zoek_bronhouder(opts = {})
  data, _status_code, _headers = zoek_bronhouder_with_http_info(opts)
  data
end

#zoek_bronhouder_with_http_info(opts = {}) ⇒ Array<(BronhouderHalCollection, Integer, Hash)>

Bevragen bronhouder met een object identificatie. Bevragen/raadplegen van een bronhouder met de identificatie van een object. De identificatie van één van de objecten: woonplaats, openbare ruimte, nummeraanduiding, ligplaats, standplaats, verblijfsobject of pand dient gespecificeerd te worden:&lt;br/&gt; Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :woonplaats_identificatie (String) —

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

  • :object_identificatie (String) —

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

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

Returns:

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

    BronhouderHalCollection data, response status code and response headers



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
254
255
256
257
258
 
# File 'lib/bag_kadaster_client/api/bronhouder_api.rb', line 202

def zoek_bronhouder_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BronhouderApi.zoek_bronhouder ...'
  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 && !opts[:'woonplaats_identificatie'].nil? && opts[:'woonplaats_identificatie'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"woonplaats_identificatie\"]' when calling BronhouderApi.zoek_bronhouder, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^[0-9]{4}(?:01|02|03|10|20|30)[0-9]{10}$|^[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 && !opts[:'object_identificatie'].nil? && opts[:'object_identificatie'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"object_identificatie\"]' when calling BronhouderApi.zoek_bronhouder, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/bronhouders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'woonplaatsIdentificatie'] = opts[:'woonplaats_identificatie'] if !opts[:'woonplaats_identificatie'].nil?
  query_params[:'objectIdentificatie'] = opts[:'object_identificatie'] if !opts[:'object_identificatie'].nil?
  query_params[:'geldigOp'] = opts[:'geldig_op'] if !opts[:'geldig_op'].nil?
  query_params[:'beschikbaarOp'] = opts[:'beschikbaar_op'] if !opts[:'beschikbaar_op'].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] || 'BronhouderHalCollection'

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

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