Class: BagKadasterClient::AdresseerbaarObjectApi
- Inherits:
-
Object
- Object
- BagKadasterClient::AdresseerbaarObjectApi
- Defined in:
- lib/bag_kadaster_client/api/adresseerbaar_object_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#bevragen_adresseerbaar_object(adresseerbaar_object_identificatie, opts = {}) ⇒ AdresseerbaarObjectIOHal
Bevragen van één adresseerbaar object met een adresseerbaar object identificatie.
-
#bevragen_adresseerbaar_object_lvc(adresseerbaar_object_identificatie, opts = {}) ⇒ AdresseerbaarObjectLvcIOHalCollection
Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie.
-
#bevragen_adresseerbaar_object_lvc_with_http_info(adresseerbaar_object_identificatie, opts = {}) ⇒ Array<(AdresseerbaarObjectLvcIOHalCollection, Integer, Hash)>
Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie.
-
#bevragen_adresseerbaar_object_with_http_info(adresseerbaar_object_identificatie, opts = {}) ⇒ Array<(AdresseerbaarObjectIOHal, Integer, Hash)>
Bevragen van één adresseerbaar object met een adresseerbaar object identificatie.
-
#initialize(api_client = ApiClient.default) ⇒ AdresseerbaarObjectApi
constructor
A new instance of AdresseerbaarObjectApi.
-
#zoek_adresseerbaar_object(opts = {}) ⇒ AdresseerbareObjectenIOHalCollection
Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie.
-
#zoek_adresseerbaar_object_with_http_info(opts = {}) ⇒ Array<(AdresseerbareObjectenIOHalCollection, Integer, Hash)>
Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AdresseerbaarObjectApi
Returns a new instance of AdresseerbaarObjectApi.
19 20 21 |
# File 'lib/bag_kadaster_client/api/adresseerbaar_object_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/adresseerbaar_object_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#bevragen_adresseerbaar_object(adresseerbaar_object_identificatie, opts = {}) ⇒ AdresseerbaarObjectIOHal
Bevragen van één adresseerbaar object met een adresseerbaar object identificatie. Bevragen van één adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
31 32 33 34 |
# File 'lib/bag_kadaster_client/api/adresseerbaar_object_api.rb', line 31 def bevragen_adresseerbaar_object(adresseerbaar_object_identificatie, opts = {}) data, _status_code, _headers = bevragen_adresseerbaar_object_with_http_info(adresseerbaar_object_identificatie, opts) data end |
#bevragen_adresseerbaar_object_lvc(adresseerbaar_object_identificatie, opts = {}) ⇒ AdresseerbaarObjectLvcIOHalCollection
Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie. Bevragen van de levenscyclus van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Met de geheleLvc parameter kan worden aangegeven of de gehele levenscyclus (inclusief voorkomens die uit de geldige levenscyclus zijn verwijderd) of alleen de actieve levenscyclus (alleen de voorkomens die onderdeel zijn van de geldige levenscyclus) gewenst zijn.
113 114 115 116 |
# File 'lib/bag_kadaster_client/api/adresseerbaar_object_api.rb', line 113 def bevragen_adresseerbaar_object_lvc(adresseerbaar_object_identificatie, opts = {}) data, _status_code, _headers = bevragen_adresseerbaar_object_lvc_with_http_info(adresseerbaar_object_identificatie, opts) data end |
#bevragen_adresseerbaar_object_lvc_with_http_info(adresseerbaar_object_identificatie, opts = {}) ⇒ Array<(AdresseerbaarObjectLvcIOHalCollection, Integer, Hash)>
Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie. Bevragen van de levenscyclus van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Met de geheleLvc parameter kan worden aangegeven of de gehele levenscyclus (inclusief voorkomens die uit de geldige levenscyclus zijn verwijderd) of alleen de actieve levenscyclus (alleen de voorkomens die onderdeel zijn van de geldige levenscyclus) gewenst zijn.
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/adresseerbaar_object_api.rb', line 125 def bevragen_adresseerbaar_object_lvc_with_http_info(adresseerbaar_object_identificatie, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc ...' end # verify the required parameter 'adresseerbaar_object_identificatie' is set if @api_client.config.client_side_validation && adresseerbaar_object_identificatie.nil? fail ArgumentError, "Missing the required parameter 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc" end pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/) if @api_client.config.client_side_validation && adresseerbaar_object_identificatie !~ pattern fail ArgumentError, "invalid value for 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc, 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 = '/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}/lvc'.sub('{' + 'adresseerbaarObjectIdentificatie' + '}', CGI.escape(adresseerbaar_object_identificatie.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'geheleLvc'] = opts[:'gehele_lvc'] if !opts[:'gehele_lvc'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json']) header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AdresseerbaarObjectLvcIOHalCollection' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyBAG'] = opts.merge( :operation => :"AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AdresseerbaarObjectApi#bevragen_adresseerbaar_object_lvc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#bevragen_adresseerbaar_object_with_http_info(adresseerbaar_object_identificatie, opts = {}) ⇒ Array<(AdresseerbaarObjectIOHal, Integer, Hash)>
Bevragen van één adresseerbaar object met een adresseerbaar object identificatie. Bevragen van één adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/bag_kadaster_client/api/adresseerbaar_object_api.rb', line 45 def bevragen_adresseerbaar_object_with_http_info(adresseerbaar_object_identificatie, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdresseerbaarObjectApi.bevragen_adresseerbaar_object ...' end # verify the required parameter 'adresseerbaar_object_identificatie' is set if @api_client.config.client_side_validation && adresseerbaar_object_identificatie.nil? fail ArgumentError, "Missing the required parameter 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object" end pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/) if @api_client.config.client_side_validation && adresseerbaar_object_identificatie !~ pattern fail ArgumentError, "invalid value for 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object, 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 = '/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}'.sub('{' + 'adresseerbaarObjectIdentificatie' + '}', CGI.escape(adresseerbaar_object_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] || 'AdresseerbaarObjectIOHal' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyBAG'] = opts.merge( :operation => :"AdresseerbaarObjectApi.bevragen_adresseerbaar_object", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AdresseerbaarObjectApi#bevragen_adresseerbaar_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#zoek_adresseerbaar_object(opts = {}) ⇒ AdresseerbareObjectenIOHalCollection
Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie. Bevragen/zoeken van alle aan een nummeraanduiding identificatie gerelateerde adresseerbare objecten (ligplaats, standplaats of verblijfsobject). Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
194 195 196 197 |
# File 'lib/bag_kadaster_client/api/adresseerbaar_object_api.rb', line 194 def zoek_adresseerbaar_object(opts = {}) data, _status_code, _headers = zoek_adresseerbaar_object_with_http_info(opts) data end |
#zoek_adresseerbaar_object_with_http_info(opts = {}) ⇒ Array<(AdresseerbareObjectenIOHalCollection, Integer, Hash)>
Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie. Bevragen/zoeken van alle aan een nummeraanduiding identificatie gerelateerde adresseerbare objecten (ligplaats, standplaats of verblijfsobject). Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
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 259 260 261 262 263 264 265 266 |
# File 'lib/bag_kadaster_client/api/adresseerbaar_object_api.rb', line 209 def zoek_adresseerbaar_object_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdresseerbaarObjectApi.zoek_adresseerbaar_object ...' end pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/) if @api_client.config.client_side_validation && !opts[:'nummeraanduiding_identificatie'].nil? && opts[:'nummeraanduiding_identificatie'] !~ pattern fail ArgumentError, "invalid value for 'opts[:\"nummeraanduiding_identificatie\"]' when calling AdresseerbaarObjectApi.zoek_adresseerbaar_object, 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 = '/adresseerbareobjecten' # query parameters query_params = opts[:query_params] || {} query_params[:'nummeraanduidingIdentificatie'] = opts[:'nummeraanduiding_identificatie'] if !opts[:'nummeraanduiding_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[:'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] || 'AdresseerbareObjectenIOHalCollection' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyBAG'] = opts.merge( :operation => :"AdresseerbaarObjectApi.zoek_adresseerbaar_object", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AdresseerbaarObjectApi#zoek_adresseerbaar_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |