{"openapi":"3.0.1","info":{"title":"Search service API","description":"REST api for search.  \n  \n  \n**For internal use**. Changes may occur at any time.","version":"1.0.0"},"servers":[{"url":"/","description":"Default Server URL"}],"paths":{"/search":{"get":{"tags":["Search service endpoint (v1)"],"summary":"Perform a search","description":"Returns a list of search results.","operationId":"search","parameters":[{"name":"X-System-ID","in":"header","description":"Short name of client system","required":true,"schema":{"type":"string"},"example":"SYSTEM-KORTNAVN"},{"name":"text","in":"query","description":"The text to search for. Matching can be for part of a text and is case-insensitive.","required":true,"schema":{"type":"string"},"example":"Hardangerv"},{"name":"size","in":"query","description":"Set the number of results returned, default is 10.","required":false,"schema":{"type":"integer","format":"int32"},"example":15},{"name":"categories","in":"query","description":"Determines which categories are used as data sources. Default `location`, `address` and `mountainPass` are used.  \nSource categories are: \n* `location` - Sentralt Stedsnavn Register (Kartverket).  \n* `address` - Matrikkelen, Norges Eiendoms Register (Kartverket).  \n* `mountainPass` - Fjelloverganger (Backend provided by Team Overblikk).  \n* `mainCategory` - Main categories (internal list).  \n* `weatherAndCamera` - Web cameras and weather stations (microservice provided by Team Veivalg).  \n* `road` - ERF-roads in Norway  (microservice provided by Team Veivalg).  \n* `roadLocation` - ERF-roads in Norway in combination with location.  \n* `bridge` - Bridges (Backend provided by Team Overblikk) \n* `tunnel` - Tunnels (Backend provided by Team Overblikk) \n* `ferryQuay` - Ferry quays (microservice provided by Team Veivalg).  \n* _trafficInformation_ is currently **not** supported as a separate data source ","required":false,"schema":{"type":"array","items":{"type":"string","description":"Enum for search result category.","enum":["location","address","mountainPass","mainCategory","trafficInformation","weatherAndCamera","road","roadLocation","bridge","tunnel","ferryQuay","regularRestArea","overnightRestArea"]}}},{"name":"lang","in":"query","description":"Language. Supported values are 'no' (Norsk bokmål), 'nn' (Norsk nynorsk) or 'en' (Engelsk). Default if not specified is 'no'.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","schema":{"type":"string","enum":["application/vnd.svv.v1+json;charset"]}}],"responses":{"200":{"description":"Successful operation","content":{"application/vnd.svv.v1+json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SearchResultCollection"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"503":{"description":"Not available"}}}},"/search/relatedFerryQuays":{"get":{"tags":["Search service endpoint (v1)"],"summary":"Performs a specialized search for related ferry quays in the `ferryQuay` category.","description":"Returns a list of related ferry quays (ie. same ferry connection).","operationId":"searchRelatedFerryQuays","parameters":[{"name":"X-System-ID","in":"header","description":"Short name of client system","required":true,"schema":{"type":"string"},"example":"SYSTEM-KORTNAVN"},{"name":"ferryQuayIds","in":"query","description":"(List of) NSR stop place id to find related ferry quays for.","required":true,"schema":{"type":"array","items":{"type":"string"}},"example":"NSR:StopPlace:18699"},{"name":"text","in":"query","description":"Optional text to search within list of related quays. Matching can be for part of a text and is case-insensitive.","required":false,"schema":{"type":"string"},"example":"Moss"},{"name":"size","in":"query","description":"Set the number of results returned, default is 10.","required":false,"schema":{"type":"integer","format":"int32"},"example":15},{"name":"lang","in":"query","description":"Language. Supported values are 'no' (Norsk bokmål), 'nn' (Norsk nynorsk) or 'en' (Engelsk). Default if not specified is 'no'.","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","schema":{"type":"string","enum":["application/vnd.svv.v1+json;charset"]}}],"responses":{"200":{"description":"Successful operation","content":{"application/vnd.svv.v1+json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SearchResultCollection"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"503":{"description":"Not available"}}}},"/search/coordinates":{"get":{"tags":["Search service endpoint (v1)"],"summary":"Retrieves address and municipality based on latitude and longitude coordinates.","description":"Returns a json with an address and municipality.","operationId":"searchByCoordinates","parameters":[{"name":"X-System-ID","in":"header","description":"Short name of client system","required":true,"schema":{"type":"string"},"example":"SYSTEM-KORTNAVN"},{"name":"lat","in":"query","description":"Latitude of coordinates.","required":true,"schema":{"type":"number","format":"double"},"example":63.3182354},{"name":"lon","in":"query","description":"Longitude of coordinates.","required":true,"schema":{"type":"number","format":"double"},"example":11.3221306},{"name":"Accept","in":"header","schema":{"type":"string","enum":["application/vnd.svv.v1+json;charset"]}}],"responses":{"200":{"description":"Successful operation","content":{"application/vnd.svv.v1+json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PointSearchResponse"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"503":{"description":"Not available"}}}}},"components":{"schemas":{"CategoryDataStatus":{"required":["category","status"],"type":"object","properties":{"category":{"type":"string","description":"Enum for search result category.","enum":["location","address","mountainPass","mainCategory","trafficInformation","weatherAndCamera","road","roadLocation","bridge","tunnel","ferryQuay","regularRestArea","overnightRestArea"]},"status":{"type":"string","description":"Data status for search result","enum":["ok","failed"]}},"description":"Category data status for search result"},"Filter":{"type":"object","properties":{"roadNumbers":{"type":"array","description":"Road number filter.","example":"E134","items":{"type":"string","description":"Road number filter.","example":"E134"}},"countyCodes":{"type":"array","description":"County codes filter.","example":"32,33","items":{"type":"integer","description":"County codes filter.","format":"int32"}}},"description":"Possible client filter settings associated with the search result."},"Geometry":{"required":["type"],"type":"object","properties":{"type":{"type":"string"}},"description":"Geometry for the search result","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/LineString"},{"$ref":"#/components/schemas/Polygon"},{"$ref":"#/components/schemas/MultiPoint"},{"$ref":"#/components/schemas/MultiLineString"},{"$ref":"#/components/schemas/MultiPolygon"}]},"LineString":{"required":["coordinates","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Geometry"},{"type":"object","properties":{"type":{"type":"string","description":"LineString"},"coordinates":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"number","description":"Coordinates in WGS 84 format","format":"double"}}}}}]},"MetaData":{"required":["dataFetch","pagination"],"type":"object","properties":{"dataFetch":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDataStatus"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"description":"Meta information describing the data collection"},"MultiLineString":{"required":["coordinates","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Geometry"},{"type":"object","properties":{"type":{"type":"string","description":"MultiLineString"},"coordinates":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"number","description":"Coordinates in WGS 84 format","format":"double"}}}}}}]},"MultiPoint":{"required":["coordinates","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Geometry"},{"type":"object","properties":{"type":{"type":"string","description":"MultiPoint"},"coordinates":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"number","description":"Coordinates in WGS 84 format","format":"double"}}}}}]},"MultiPolygon":{"required":["coordinates","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Geometry"},{"type":"object","properties":{"type":{"type":"string","description":"MultiPolygon"},"coordinates":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"number","description":"Coordinates in WGS 84 format","format":"double"}}}}}}}]},"Pagination":{"required":["matchedElements","totalElements"],"type":"object","properties":{"totalElements":{"type":"integer","format":"int32"},"matchedElements":{"type":"integer","format":"int32"}},"description":"Pagination information for collections"},"Point":{"required":["coordinates","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Geometry"},{"type":"object","properties":{"type":{"type":"string","description":"Point"},"coordinates":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"number","description":"Coordinates in WGS 84 format","format":"double"}}}}]},"Polygon":{"required":["coordinates","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Geometry"},{"type":"object","properties":{"type":{"type":"string","description":"Polygon"},"coordinates":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"array","description":"Coordinates in WGS 84 format","items":{"type":"number","description":"Coordinates in WGS 84 format","format":"double"}}}}}}]},"SearchResult":{"required":["category","iconName","id","isMainCategory","mainLabel"],"type":"object","properties":{"geometry":{"$ref":"#/components/schemas/Geometry"},"category":{"type":"string","description":"Enum for search result category.","example":"location","enum":["location","address","mountainPass","mainCategory","trafficInformation","weatherAndCamera","road","roadLocation","bridge","tunnel","ferryQuay","regularRestArea","overnightRestArea"]},"isMainCategory":{"type":"boolean","description":"Indicating if this is the main element for the category or not ","example":false},"objectType":{"type":"string","description":"Object type","example":"By"},"objectId":{"type":"string","description":"Object id","example":"81833493"},"mainLabel":{"type":"string","description":"Main label","example":"Fredrikstad"},"secondaryLabel":{"type":"string","description":"Secondary label","example":"By, Fredrikstad, Østfold"},"iconName":{"type":"string","description":"Icon name (from 'FT designsystem' in Figma).","example":"locationDot","enum":["locationDot","weatherAndCamera","mountainPass","trafficInformation","webcamera","weatherStation","weatherExposedRoad","road","roadLocation","search","bridge","tunnel","ferryQuay","regularRestArea","overnightRestArea"]},"filter":{"$ref":"#/components/schemas/Filter"},"id":{"type":"string","description":"Unique ID identifying search result","example":"328a467251e9310a"}},"description":"Model for search result."},"SearchResultCollection":{"required":["metadata","searchResults"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetaData"},"searchResults":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}}},"description":"Collection of search results"},"PointSearchResponse":{"required":["adresse","kommunenavn"],"type":"object","properties":{"adresse":{"type":"string"},"kommunenavn":{"type":"string"},"lat":{"type":"number","format":"double"},"lon":{"type":"number","format":"double"}}}}}}