Skip to content

dev'http_api'reference'GeoObject.Find

Usagi Ito edited this page Nov 14, 2017 · 2 revisions

GeoObject.Find

条件により GeoObject 群を絞り込みます。

Params

{ "ids": [ <number;id> ] // optional
, "finders":
  [ { "type": "PropertyPatterns"
    , "patterns":
      [ { "mode": <string> // "KeyExists", "ValueIs", "ValueIsNot", 
                           // "ValueNumberGreaterThan", "ValueNumberGreaterThanEqual"
                           // "ValueNumberLessThan", "ValueNumberLessThanEqual"
                           // "ValueMatchesWildcard", "ValueNotMatchesWildcard"
                           // "ValueMatchesRegex", "ValueNotMatchesRegex"
        , "key": <string>
        , "value": <string> // optional
        , "is_case_sensitive": <bool> // optional
        }
      ] 
    } // optional
  , { "type": "TagPattern"
    , "mode": <string> // "And", "Or", "NotAnd", "NorOr"
    , "tags": [ <string;tag> ]
    } // optional
  , { "type": "PlaneAreaRectangular"
    , "center_and_delta":
      { "center": { "latitude": <number;deg>, "longitude": <number;deg> }
      , "delta": { "latitude": <number;deg>, "longitude": <number;deg> }
      } // optional
    , "points":
      { "latitude": { "a": <number;deg>, "b": <number;deg> }
      , "longitude": { "a": <number;deg>, "b": <number;deg> }
      } // optional
    , "inclusion_pattern": <string> // "Any", "All"
    } // optional
  , { "type": "PlaneAreaCircle"
    , "center": { "latitude": <number;deg>, "longitude": <number;deg> }
    , "radius": <number;m>
    , "inclusion_pattern": <string> // "Any", "All"
    } // optional
  , { "type": "AltitudeRange"
    , "a": <number;m>
    , "b": <number;m>
    , "inclusion_pattern": <string> // "Any", "All"
    } // optional
  ]
}
  • ids 省略時は現存する全ての GeoObject が対象になります。
  • type=PropertyPatterns:
    • patterns リストに複数のパターンを与えた場合の検索間の挙動は AND となります。
    • mode=KeyExists では「ない」場合:
      • value が必須です。
      • WildcardRegex 系では is_case_sensitive が必須です。
  • type=PlaneAreaRectangular:
    • center_and_delta または points のいずれかが必須です。
  • finders に複数の条件を与えた場合の検索間の挙動は AND となります。

Result

[ <number;id>
]

Error

Code Message Situation and Factors
-32602 Invalid Parameter 不正な引数でリクエストした
Clone this wiki locally
You can’t perform that action at this time.