Garoon APIドキュメント

アドレスを検索する

目次

アドレスを検索する

固定リンクがコピーされました

アドレス帳のIDと検索キーワードをリクエストのパラメーターとして受け取り、検索にマッチしたアドレスをレスポンスとして返すAPIです。

API名

固定リンクがコピーされました

AddressSearchCards

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@book_id base:IDType 1 検索対象のアドレス帳のID。個人アドレス帳を検索する場合は、「-1」を指定する。
@case_sensitive xsd:boolean 1 大文字小文字の区別
  • true：する
  • false：しない
@text xsd:string 1 検索キーワード
例
1

<parameters book_id="1" case_sensitive="false" text="user"></parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
card address:CardType 0～ 無制限 検索にマッチしたアドレス
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

<returns>
  <card book_id="1" id="2" version="1281488793" xmlns:card="http://schemas.cybozu.co.jp/address/2008">
    <card:creator user_id="1" name="Administrator"  date="2010-08-11T01:06:33Z" />
    <card:modifier user_id="1" name="Administrator" date="2010-08-11T01:06:33Z" />
    <card:subject>userアドレス帳</card:subject>
    <card:personal_name>
      <card:part>user</card:part>
      <card:part>name</card:part>
    </card:personal_name>
    <card:personal_reading>
      <card:part>user</card:part>
      <card:part>name</card:part>
    </card:personal_reading>
  </card>
</returns>