APIリファレンス(JavaScript)

baasatrakuza > DataClient > getByLocation

DataClient.getByLocation() method

コードを指定して、位置情報でデータオブジェクト1件を取得します

Signature:

getByLocation(objectId: string, code: string, location?: RKZLocation, spotFieldName?: string): Promise<Data>;

Parameters

Parameter	Type	Description
objectId	string	オブジェクトID
code	string	コード
location	RKZLocation	検索対象の位置情報
spotFieldName	string	スポットオブジェクトを指定している項目名。 スポットオブジェクトに関連付けしている項目が1つしかない場合は省略可能です。 複数の項目を指定している場合、この項目に指定した項目名をスポット検索条件として利用します。

Returns:

Promise<Data>

データオブジェクト

Remarks

スポットオブジェクトの項目を定義している場合、RKZLocation.latitude、RKZLocation.longitudeとSpot.latitude、Spot.longitudeを比較して、locationの位置情報に近いスポットオブジェクトを設定している順番に並べ替えて抽出します。

スポットオブジェクトはDataのattributesに{スポットオブジェクトを指定した項目名}_objectsというプロパティ名で設定されます。

スポットオブジェクトの項目がない場合、DataResult.dataが0件のレスポンスを返します。

WARNING

データが見つからない場合、RKZError.notFoundError()の結果を返します