Index
共有アドレス帳のアドレスを取得する
共有アドレス帳のIDとアドレスのIDをリクエストのパラメーターとして受け取り、アドレスの情報をレスポンスとして返すAPIです。
API名
AddressGetSharedCardsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
card_id/text() | base:IDType | 1 ~ 無制限 | 情報を取得するアドレスのID |
@book_id | base:IDType | 1 | 情報を取得する共有アドレス帳のID |
例
<parameters book_id="1"> <card_id>1</card_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
card | address:CardType | 1 ~ 無制限 | card_idで指定されたアドレスの情報 |
例
<returns xmlns=""> <card id="1" version="1" book_id="1"> <creator user_id="1" name="佐藤 太郎" date="2009-02-02T00:00:00" /> <modifier user_id="1" name="佐藤 太郎" date="2009-02-02T00:00:00" /> <subject>ボウズマン</subject> <personal_name> <part>Family name</part> <part>Given name</part> </personal_name> <personal_reading> <part>Family sort key</part> <part>Given sort key</part> </personal_reading> <company_name>サイボウズ株式会社</company name> <company_reading>さいぼうずかぶしきかいしゃ</company reading> <section>開発本部</section> <zip_code>112-0004</zip_code> <physical_address>東京都文京区後楽 1-4-14 後楽森ビル 12F</physical_address> <map>http://www.</map> <route> <path>新宿-飯田橋</path> <time>30 分</time> <fare>190 円</fare> </route> <company_tel>03-5805-9767</company_tel> <company_fax>03-5805-9767</company_fax> <url>http://cybozu.co.jp/</url> <post>イメージキャラクタ</post> <personal_tel>0120-00-0000</personal_tel> <email>bozuman@cybozu.co.jp</email> <image file_id="3" name="bozuman.gif" size="1024" mime_type="image/gif"> <base:content /> </image> <description>ボウズマンです</description> <custom> <string field_code="string">1 行文字列</string> <text field_code="text">複数行文字列</text> <url field_code="url_code">URL</url> <file file_id="3" name="ファイル.txt" size="1024" mime_type="plain/text" field_code="file_code" version="1"> <base:content /> </file> <email field_code="email_code">bozuman@cybozu.co.jp</email> <ipphone field_code="ipphone_code">callto:00-000-0000</ipphone> <menu>項目 1</menu> </custom> </card> </returns>
エラー
エラー番号 | 説明 |
GRN_ADDR_22001 | book_idで指定された共有アドレス帳が存在しない |
GRN_ADDR_22203 | card_idで指定されたアドレスが存在しない |
共有アドレス帳を取得する
共有アドレス帳のIDをリクエストのパラメーターとして受け取り、アドレス帳の情報をレスポンスとして返すAPIです。book_id で指定した ID のアドレス帳が存在しない場合、API は空の情報を返します。
API名
AddressGetSharedBooksById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
book_id/text() | base:IDType | 1 ~ 無制限 | 情報を取得する共有アドレス帳のID |
例
<parameters> <book_id>1</book_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
book | address:BookType | 0 ~ 無制限
|
book_idで指定された共有アドレス帳の情報 |
例 クラウド版 Garoon、パッケージ版 Garoon バージョン 3.1.0以降
<returns xmlns=""> <book book_id=”1” key="book0" name="ブック 1" type="ldap" version="1" > <form key="form0" version="1" xmlns="http://schemas.cybozu.co.jp/address/2008"> <subject name="標題" using="true" listing="true" necessary="true" allow_modification="false" field_code="subject" /> <personal_name name="名前" using="true" listing="true" necessary="false" allow_modification="true" field_code="personal_name" /> <personal_reading name="よみ" using="true" listing="false" necessary="false" allow_modification="true" field_code="personal_reading" /> <company_name name="会社名" using="true" listing="true" necessary="false" allow_modification="true" field_code="company_name" /> <company_reading name="会社よみ" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_reading" /> <section name="部課名" using="true" listing="true" necessary="false" allow_modification="true" field_code="section" /> <zip_code name="郵便番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="zip_code" /> <physical_address name="住所" using="true" listing="false" necessary="false" allow_modification="true" field_code="physical_address" /> <map name="地図" using="true" listing="false" necessary="false" allow_modification="true" field_code="map" /> <route name="路線" using="true" listing="false" necessary="false" allow_modification="true" field_code="route" /> <company_tel name="会社電話番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_tel" /> <company_fax name="会社 FAX 番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_fax" /> <url name="URL" using="true" listing="false" necessary="false" allow_modification="true" field_code="url" /> <post name="役職名" using="true" listing="false" necessary="false" allow_modification="true" field_code="post" /> <personal_tel name="個人電話番号" using="true" listing="true" necessary="false" allow_modification="true" field_code="personal_tel" /> <email name="E-mail" using="true" listing="true" necessary="false" allow_modification="true" field_code="email" /> <image name="画像" using="true" listing="false" necessary="false" allow_modification="true" field_code="image" /> <description name="メモ" using="true" listing="false" necessary="false" allow_modification="true" field_code="description" /> <custom> <string name="1 行文字列" using="true" listing="false" necessary="false" allow_modification="true" field_code="string" /> <text name="複数行文字列" using="true" listing="false" necessary="false" allow_modification="true" field_code="text" /> <url name="URL" using="true" listing="false" necessary="false" allow_modification="true" field_code="file" /> <file name="ファイル" using="true" listing="false" necessary="false" allow_modification="true" field_code="file" /> <email name="E-mail" using="true" listing="false" necessary="false" allow_modification="true" field_code="email" /> <ipphone name="IPPhone" using="true" listing="false" necessary="false" allow_modification="true" field_code="ipphone" /> </custom> </form> <cards xmlns="http://schemas.cybozu.co.jp/address/2008"> <card id="1" /> <card id="2" /> </cards> </book> </returns>
パッケージ版 Garoon バージョン 3.1.x
<returns xmlns=""> <book key="book0" name="ブック 1" type="ldap" version="1"> <form key="form0" version="1" xmlns="http://schemas.cybozu.co.jp/address/2008"> <subject name="標題" using="true" listing="true" necessary="true" allow_modification="false" field_code="subject" /> <personal_name name="名前" using="true" listing="true" necessary="false" allow_modification="true" field_code="personal_name" /> <personal_reading name="よみ" using="true" listing="false" necessary="false" allow_modification="true" field_code="personal_reading" /> <company_name name="会社名" using="true" listing="true" necessary="false" allow_modification="true" field_code="company_name" /> <company_reading name="会社よみ" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_reading" /> <section name="部課名" using="true" listing="true" necessary="false" allow_modification="true" field_code="section" /> <zip_code name="郵便番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="zip_code" /> <physical_address name="住所" using="true" listing="false" necessary="false" allow_modification="true" field_code="physical_address" /> <map name="地図" using="true" listing="false" necessary="false" allow_modification="true" field_code="map" /> <route name="路線" using="true" listing="false" necessary="false" allow_modification="true" field_code="route" /> <company_tel name="会社電話番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_tel" /> <company_fax name="会社 FAX 番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_fax" /> <url name="URL" using="true" listing="false" necessary="false" allow_modification="true" field_code="url" /> <post name="役職名" using="true" listing="false" necessary="false" allow_modification="true" field_code="post" /> <personal_tel name="個人電話番号" using="true" listing="true" necessary="false" allow_modification="true" field_code="personal_tel" /> <email name="E-mail" using="true" listing="true" necessary="false" allow_modification="true" field_code="email" /> <image name="画像" using="true" listing="false" necessary="false" allow_modification="true" field_code="image" /> <description name="メモ" using="true" listing="false" necessary="false" allow_modification="true" field_code="description" /> <custom> <string name="1 行文字列" using="true" listing="false" necessary="false" allow_modification="true" field_code="string" /> <text name="複数行文字列" using="true" listing="false" necessary="false" allow_modification="true" field_code="text" /> <url name="URL" using="true" listing="false" necessary="false" allow_modification="true" field_code="file" /> <file name="ファイル" using="true" listing="false" necessary="false" allow_modification="true" field_code="file" /> <email name="E-mail" using="true" listing="false" necessary="false" allow_modification="true" field_code="email" /> <ipphone name="IPPhone" using="true" listing="false" necessary="false" allow_modification="true" field_code="ipphone" /> </custom> </form> <cards xmlns="http://schemas.cybozu.co.jp/address/2008"> <card id="1" /> <card id="2" /> </cards> </book> </returns>
個人アドレス帳のアドレスを取得する
個人アドレス帳のアドレスのIDをリクエストのパラメーターとして受け取り、アドレスの情報をレスポンスとして返すAPIです。
API名
AddressGetPersonalCardsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
card_id/text() | base:IDType | 1 ~ 無制限 | 情報を取得する個人アドレス帳のアドレスのID |
例
<parameters> <card_id>1</card_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
card | address:CardType | 1 ~ 無制限 | card_idで指定されたアドレスの情報 |
例
<returns xmlns=""> <card id="1" version="1" book_id="1"> <creator user_id="1" name="佐藤 太郎" date="2009-02-02T00:00:00" /> <modifier user_id="1" name="佐藤 太郎" date="2009-02-02T00:00:00" /> <subject>ボウズマン</subject> <personal_name> <part>Family name</part> <part>Given name</part> </personal_name> <personal_reading> <part>Family sort key</part> <part>Given sort key</part> </personal_reading> <company_name>サイボウズ株式会社</company_name> <company_reading>さいぼうずかぶしきかいしゃ</company_reading> <section>開発本部</section> <zip_code>112-0004</zip_code> <physical_address>東京都文京区後楽 1-4-14 後楽森ビル 12F</physical_address> <map>http://www.</map> <route> <path>新宿-飯田橋</path> <time>30 分</time> <fare>190 円</fare> </route> <company_tel>03-5805-9767</company_tel> <company_fax>03-5805-9767</company_fax> <url>http://cybozu.co.jp/</url> <post>イメージキャラクタ</post> <personal_tel>0120-00-0000</personal_tel> <email>bozuman@cybozu.co.jp</email> <image file_id="3" name="bozuman.gif" size="1024" mime_type="image/gif" version="1"> <base:content /> </image> <description>ボウズマンです</description> <custom> <string field_code="string">1 行文字列</string> <text field_code="text">複数行文字列</text> <url field_code="url_code">URL</url> <file name="ファイル.txt" size="1024" mime_type="plain/text" field_code="file_code" rsion="1"> <base:content /> </file> <email field_code="email_code">bozuman@cybozu.co.jp</email> <ipphone field_code="ipphone_code">callto:00-000-0000</ipphone> <menu>項目 1</menu> </custom> </card> </returns>
エラー
エラー番号 | 説明 |
GRN_ADDR_22203 | card_idで指定されたアドレスが存在しない |
個人アドレス帳を取得する
個人アドレス帳の ID をリクエストのパラメーターとして受け取り、個人アドレス帳の情報をレスポンスとし て返す API です。 book_id で指定した ID の個人アドレス帳が存在しない場合、API は空の情報を返します。
API名
AddressGetPersonalBooksById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
book_id/text() | base:IDType | 1 ~ 無制限 | 情報を取得する個人アドレス帳のID |
例
<parameters> <book_id>1</book_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
book | address:BookType | 0 ~ 無制限
|
book_idで指定された個人アドレス帳の情報 |
例
<returns xmlns=""> <book key="book0" name="ブック 1" type="ldap" version="1"> <form key="form0" version="1" xmlns="http://schemas.cybozu.co.jp/address/2008"> <subject name="標題" using="true" listing="true" necessary="true" allow_modification="false" field_code="subject" /> <personal_name name="名前" using="true" listing="true" necessary="false" allow_modification="true" field_code="personal_name" /> <personal_reading name="よみ" using="true" listing="false" necessary="false" allow_modification="true" field_code="personal_reading" /> <company_name name="会社名" using="true" listing="true" necessary="false" allow_modification="true" field_code="company_name" /> <company_reading name="会社よみ" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_reading" /> <section name="部課名" using="true" listing="true" necessary="false" allow_modification="true" field_code="section" /> <zip_code name="郵便番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="zip_code" /> <physical_address name="住所" using="true" listing="false" necessary="false" allow_modification="true" field_code="physical_address" /> <map name="地図" using="true" listing="false" necessary="false" allow_modification="true" field_code="map" /> <route name="路線" using="true" listing="false" necessary="false" allow_modification="true" field_code="route" /> <company_tel name="会社電話番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_tel" /> <company_fax name="会社 FAX 番号" using="true" listing="false" necessary="false" allow_modification="true" field_code="company_fax" /> <url name="URL" using="true" listing="false" necessary="false" allow_modification="true" field_code="url" /> <post name="役職名" using="true" listing="false" necessary="false" allow_modification="true" field_code="post" /> <personal_tel name="個人電話番号" using="true" listing="true" necessary="false" allow_modification="true" field_code="personal_tel" /> <email name="E-mail" using="true" listing="true" necessary="false" allow_modification="true" field_code="email" /> <image name="画像" using="true" listing="false" necessary="false" allow_modification="true" field_code="image" /> <description name="メモ" using="true" listing="false" necessary="false" allow_modification="true" field_code="description" /> <custom> <string name="1 行文字列" using="true" listing="false" necessary="false" allow_modification="true" field_code="string" /> <text name="複数行文字列" using="true" listing="false" necessary="false" allow_modification="true" field_code="text" /> <url name="URL" using="true" listing="false" necessary="false" allow_modification="true" field_code="file" /> <file name="ファイル" using="true" listing="false" necessary="false" allow_modification="true" field_code="file" /> <email name="E-mail" using="true" listing="false" necessary="false" allow_modification="true" field_code="email" /> <ipphone name="IPPhone" using="true" listing="false" necessary="false" allow_modification="true" field_code="ipphone" /> </custom> </form> <cards xmlns="http://schemas.cybozu.co.jp/address/2008"> <card id="1" /> <card id="2" /> </cards> </book> </returns>
共有アドレス帳の更新情報を取得する
共有アドレス帳のバージョンを取得するAPIです。
API名
AddressGetSharedBookVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
book_item | base:ItemVersionType | 0 ~ 無制限 | 情報を取得する共有アドレス帳のバージョン |
例
<parameters> <book_item id=”1” version=”1276753762”></book_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
book_item | base:ItemVersionResultType | 0 ~ 無制限 | 共有アドレス帳の更新情報 |
例
<returns> <book_item id="1" version="1191475888" operation="modify" /> <book_item id="2" version="1191475924" operation="add" /> <book_item id="3" version="1191475956" operation="add" /> <book_item id="4" version="1191475992" operation="add" /> </returns>
個人アドレス帳の更新情報を取得する
個人アドレス帳のバージョンを修得するAPIです。
API名
AddressGetPersonalBookVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
book_item | base:ItemVersionType | 0 ~ 無制限 | 情報を取得する個人アドレス帳のバージョン |
例
<parameters> <book_item id=”1” version=”1276753762”></book_item> <book_item id=”2” version=”1276756433”></book_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
book_item | base:ItemVersionResultType | 0 ~ 無制限 | 個人アドレス帳の更新情報 |
例
<returns> <book_item id="1" operation="modify" version="1276753763"/> <book_item id="2" operation="modify" version="1276755324"/> <book_item id="3" operation="add" version="1276785256"/> </returns>
共有アドレス帳のアドレスの更新情報を取得する
共有アドレス帳のアドレスのバージョンをリクエストのパラメーターとして受け取り、共有アドレス帳のアドレスの更新情報をレスポンスとして返す API です。
API名
AddressGetSharedCardVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
card_item | base:ItemVersionType | 0 ~ 無制限 | 情報を取得する共有アドレス帳のアドレスのバージョン |
例
<parameters> <card_item id=”1” version=”1276753762”></card_item> <card_item id=”2” version=”1276756433”></card_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
card_item | base:ItemVersionResultType | 0 ~ 無制限 | 共有アドレス帳のアドレスの更新情報 |
例
<returns> <card_item id=”1” operation=”modify” version=”1276753763” /> <card_item id=”2” operation=”modify” version=”1276755324” /> <card_item id=”3” operation=”add” version=”1276785256” /> </returns>
個人アドレス帳のアドレスの更新情報を取得する
個人アドレス帳のバージョンをリクエストのパラメーターとして受け取り、個人アドレス帳の更新情報をレ スポンスとして返す API です。
API名
AddressGetPersonalCardVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
card_item | base:ItemVersionType | 0 ~ 無制限 | 情報を取得する個人アドレス帳のアドレスのバージョン |
例
<parameters> <card_item id=”1” version=”1276753762”></card_item> <card_item id=”2” version=”1276756433”></card_item> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
card_item | base:ItemVersionResultType | 0 ~ 無制限 | 個人アドレス帳のアドレスの更新情報 |
例
<returns> <card_item id=”1” operation=”modify” version=”1276753763” /> <card_item id=”2” operation=”modify” version=”1276755324” /> <card_item id=”3” operation=”add” version=”1276785256” /> </returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。