{"source":"sodir","operation":"search_companies","description":"Search companies registered as operators or licensees on the shelf.","parameters":[{"name":"name","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Partial company name, e.g. \"aker\" or \"Equinor\"."},{"name":"org_nr","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Norwegian organisation number (9 digits), exact match. One number can return several rows: Sodir keeps the entity's former names (Statoil, Den norske stats oljeselskap) alongside the current one."},{"name":"current_operator_only","schema":{"type":"boolean"},"required":false,"default":false,"description":"True to keep only companies that currently operate at least one production licence."},{"name":"limit","schema":{"type":"integer"},"required":false,"default":50,"description":"Maximum companies to return (default 50, max 200)."},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page."}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies?name={name}&org_nr={org_nr}&current_operator_only=false&limit=50&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"count":{"type":["integer","null"]},"returned":{"type":"integer"},"note":{"type":"string"}},"additionalProperties":false},"response_schema_status":{"status":"inferred","codegen_safe":true,"description":"Safe for code generation from the currently published fields. The contract is statically inferred rather than independently maintained, so clients should tolerate additional fields."},"entity_projection":{"status":"projected","entity_types":["organization"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_companies","source":"https://allemannsdata.com/wiki/api/v1/kilder/sodir","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["count","returned","note"],"output_fields_truncated":false,"canonical_field_aliases":{}}