{"source":"sodir","operation":"search_facilities","description":"Search fixed offshore facilities: platforms, subsea templates, pipeline\nlandfalls, loading systems and the like.","parameters":[{"name":"name","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Partial facility name, e.g. \"TROLL A\" or \"sleipner\"."},{"name":"kind","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Structure type, e.g. \"CONDEEP 4 SHAFTS\", \"JACKET 8 LEGS\", \"FPSO\", \"SUBSEA STRUCTURE\", \"LOADING SYSTEM\"."},{"name":"phase","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"\"IN SERVICE\", \"SHUT DOWN\", \"REMOVED\", \"FUTURE\", \"DECOMMISSIONED\" and similar."},{"name":"operator","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Partial current operator name."},{"name":"belongs_to","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Partial name of the field or installation it belongs to."},{"name":"limit","schema":{"type":"integer"},"required":false,"default":50,"description":"Maximum facilities 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_facilities?name={name}&kind={kind}&phase={phase}&operator={operator}&belongs_to={belongs_to}&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":"intentionally_none","entity_types":[],"description":"No stable cross-source entity projection is defined for this operation; entities is intentionally empty."},"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_facilities/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/sodir/search_facilities","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":{}}