アドレスを検索する

フォローする

アドレスを検索する

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

API名

AddressSearchCards

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

  • Garoon on cybozu
  • パッケージ版 バージョン 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>

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk