{"components":{"responses":{"BadRequest":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Bad Request"},"Forbidden":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Forbidden"},"InternalServerError":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Internal Server Error"},"NotFound":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Not Found"},"Unauthorized":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JSONAPIErrorResponse"}}},"description":"Unauthorized"}},"schemas":{"Address":{"properties":{"buildingID":{"example":1705100000018686,"type":"integer"},"buildingStatus":{"example":"PAND_IN_GEBRUIK","type":"string"},"buildingYear":{"example":1980,"type":"integer"},"city":{"example":"Amsterdam","type":"string"},"houseLetter":{"example":"B","type":"string"},"houseNumber":{"example":25,"type":"integer"},"houseNumberAddition":{"example":"-","type":"string"},"lat":{"example":51.89079,"type":"number"},"lon":{"example":5.997303,"type":"number"},"municipality":{"example":"Lingewaard","type":"string"},"numberIndication":{"example":1705200000120734,"type":"integer"},"objectID":{"example":1705010000033915,"type":"integer"},"postalCode":{"example":"1081SD","type":"string"},"province":{"example":"Noord-Holland","type":"string"},"secondaryAddress":{"example":false,"type":"boolean"},"status":{"example":"VERBLIJFSOBJECT_IN_GEBRUIK","type":"string"},"street":{"example":"majanstraat","type":"string"},"surfaceArea":{"example":34,"type":"integer"},"usagePurpose":{"example":"overige gebruiksfunctie","type":"string"},"x":{"example":196998.513,"type":"number"},"y":{"example":196998.513,"type":"number"}},"type":"object"},"JSONAPIErrorResponse":{"properties":{"errors":{"items":{"properties":{"code":{"description":"an application-specific error code. It can be the same as 'status'","type":"string"},"detail":{"description":"a human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized","type":"string"},"status":{"description":"the HTTP status code applicable to this problem","maxLength":3,"minLength":3,"type":"string"},"title":{"description":"a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization","type":"string"}},"required":["status","code","title","detail"],"type":"object"},"minItems":1,"title":"An array of Error objects","type":"array"}},"required":["errors"],"title":"JSON:API Error Response","type":"object"},"JSONAPILink":{"description":"A JSON:API link can be either a URL string or a structured link object.","oneOf":[{"example":"https://example.com/","format":"url","type":"string"},{"$ref":"#/components/schemas/JSONAPILinkObject"}],"title":"JSON:API Link"},"JSONAPILinkObject":{"description":"a structured representation of a URL","properties":{"href":{"example":"/organizations/<cin>","type":"string"},"meta":{"example":{"count":"10"},"type":"object"}},"required":["href"],"title":"JSON:API Link Object","type":"object"},"JSONAPILinksObject":{"description":"May contain `self`, `related`, or pagination links (first, last, prev, next).","properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"related":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"title":"JSON:API Links Object"},"JSONAPIRelationshipLink":{"description":"a structured representation of a Relationship","properties":{"data":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"}},"title":"JSON:API Relationship Link Object","type":"object"},"JSONAPIResourceObject":{"description":"JSON:API Resource Object","properties":{"id":{"description":"JSON:API id Member","title":"JSON:API id Member","type":"string"},"links":{"$ref":"#/components/schemas/JSONAPILinksObject"},"type":{"description":"JSON:API type Member","title":"JSON:API type Member","type":"string"}},"required":["type"],"title":"JSON:API Resource Object","type":"object"},"LocationSearchFilter":{"properties":{"city":{"example":"amsterdam","type":"string"},"houseLetter":{"example":"A","type":"string"},"houseNumber":{"example":12,"type":"integer"},"houseNumberAddition":{"example":"02","type":"string"},"municipality":{"example":"Amsterdam","type":"string"},"postalCode":{"example":"1111AA","type":"string"},"postalCodeRange":{"example":"1231RV,1431RV","type":"string"},"province":{"example":"Noord-Holland","type":"string"},"street":{"example":"streetname","type":"string"}},"title":"Filter","type":"object"},"LocationSearchItem":{"description":"result of the search for a location","properties":{"attributes":{"$ref":"#/components/schemas/Address"},"id":{"example":"01002486-000013857983","type":"string"},"links":{"properties":{"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"type":{"example":"locations","type":"string"}},"title":"Location Search Item","type":"object"},"LocationSearchMatch":{"properties":{"city":{"example":"amster","type":"string"},"postalCode":{"example":"1111AB","type":"string"},"street":{"example":"straat","type":"string"}},"title":"Match","type":"object"},"LocationSearchResults":{"description":"results of the search for Locations","properties":{"data":{"items":{"$ref":"#/components/schemas/LocationSearchItem"},"type":"array"},"links":{"properties":{"first":{"$ref":"#/components/schemas/JSONAPILink"},"last":{"$ref":"#/components/schemas/JSONAPILink"},"next":{"$ref":"#/components/schemas/JSONAPILink"},"prev":{"$ref":"#/components/schemas/JSONAPILink"},"self":{"$ref":"#/components/schemas/JSONAPILink"}},"type":"object"},"meta":{"properties":{"totalPages":{"type":"integer"},"totalResults":{"type":"integer"}},"type":"object"}},"title":"Location Search Results","type":"object"},"Page":{"properties":{"number":{"default":1,"description":"This parameter specifies the page number.","type":"integer"},"size":{"default":10,"description":"The number of records to return in each page.","type":"integer"}},"type":"object"},"Result":{"properties":{"count":{"example":6,"type":"integer"},"value":{"example":"amsterdam","type":"string"}},"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"X-API-KEY","type":"apiKey"}}},"info":{"description":"NL Locations API represents the Searching of the dutch locations\n","title":"NL Locations","version":"1.0.0"},"openapi":"3.0.0","paths":{"/nl/locations":{"get":{"description":"***\n\n# About this API\n\nTo get the ins and outs of this API, please refer to our documentation page [here](https://docs.company.info/docs/nl-locations)\n\n***\n\n# Service limitations\n\nTo ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.\n\n***\n\n# How to use this page?\n\n1. Pick a preferred language on the right.\n2. Enter your API key in the `header` field. Don't have one yet or don't know what that is? Please refer to the following page [here](https://docs.company.info/reference/api-keys-1).\n3. Enter the required parameters below or try something yourself!\n4. Click the `Try It!` button!\n\n> 📘 You can also press one of the HTTP response codes on the right to see an example of that specific response!\n","operationId":"getNlLocations","parameters":[{"description":"Searches an address based on given parameters. Will use all of the values given and return results based on the best match.\n<br>Minimum amount of characters is 2.\"\n","in":"query","name":"query","schema":{"example":"street city 1111AB","type":"string"}},{"description":"Filter is used for an exact match. So if the given input doesn't 100% match, no results are given. \n<br><b>The example below contains all the possible filters</b>\"\n","in":"query","name":"filter","schema":{"$ref":"#/components/schemas/LocationSearchFilter"},"style":"deepObject"},{"description":"Match will search with the given parameters and returns a list based on the highest score. Doesn't have to be an exact match and can contain non complete values.\n<br><b>The example below contains all the possible matches</b>\"\n","in":"query","name":"match","schema":{"$ref":"#/components/schemas/LocationSearchMatch"},"style":"deepObject"},{"description":"Sort field can be used to sort the result of the search.\n<br> The order of the sort can be either `descending` or `ascending`.\n<br> By default, we sort the results based on `id` and `descending`.\n<br> It's been implemented based on the JSONAPI conventions, so to have multiple\nsorting orders you must separate it by commas. Also, by default the sort\norder is ascending, to change it to descending you must use a `-` before the field name\n<br> supported fields: `id,city,street`\n","in":"query","name":"sort","schema":{"example":"-city,street","type":"string"}},{"description":"`size` defines the number of records to return in each page.\ndefault value: 10, maximum value: 20.\n<br>`number` specifies the page number.\"\n","in":"query","name":"page","schema":{"$ref":"#/components/schemas/Page"},"style":"deepObject"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/LocationSearchResults"}}},"description":"OK","headers":{"X-Correlation-Id":{"description":"Unique request identifier","schema":{"format":"uuid","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"summary":"Search Locations","tags":["Search"]}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"description":"Production Server","url":"https://api.company.info"}],"tags":[{"description":"Calls related to the NL Location API","name":"NL Locations"}],"x-readme":{"proxy-enabled":false}}