アドレスを検索する

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

API名

AddressSearchCards

使用可能なガルーンのバージョン

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.0.0以降

リクエスト

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

例

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

レスポンス

パラメーター名	型	パラメーター数	説明
card	address:CardType	0 ～無制限	検索にマッチしたアドレス

例

<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>

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。