アドレスを登録する
追加するアドレスをリクエストのパラメーターとして受け取り、追加し、追加されたアドレス情報をレスポンスとして返す API です。
API名
AddressAddCards
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
例
1
2
3
4
5
6
7
8
9
10
|
<parameters>
<add_card>
<card book_id="1" id="dummy" version="dummy">
<creator user_id="1" name="dummy" date="dummy"></creator>
<subject>アドレス帳タイトル</subject>
<personal_name><part>個人名</part></personal_name>
<personal_reading><part>こじんめい</part></personal_reading>
</card>
</add_card>
</parameters>
|
レスポンス
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<returns>
<card book_id="1" id="1" version="1281486678" xmlns:card="http://schemas.cybozu.co.jp/address/2008">
<card:creator user_id="1" name="Administrator" date="2010-08-11T00:31:18Z" />
<card:modifier user_id="1" name="Administrator" date="2010-08-11T00:31:18Z" />
<card:subject>アドレス帳タイトル</card:subject>
<card:personal_name>
<card:part>個人名</card:part>
<card:part></card:part>
</card:personal_name>
<card:personal_reading>
<card:part>こじんめい</card:part>
<card:part></card:part>
</card:personal_reading>
</card>
</returns>
|
エラー
エラー番号 |
説明 |
GRN_UTIL_API_65009 |
アップロードするファイルのサイズが、Base64 エンコード後で 300MB より大きい場合 |
アドレスを更新する
変更するアドレスをリクエストのパラメーターとして受け取り、変更し、変更されたアドレス情報をレスポンスとして返す API です。
API名
AddressModifyCards
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
例
1
2
3
4
5
6
7
8
9
10
|
<parameters>
<modify_card>
<card xmlns="" book_id="1" id="1" version="dummy">
<creator user_id="1" name="dummy" date="dummy"></creator>
<subject>アドレス帳タイトル - modified</subject>
<personal_name><part>個人名-modified</part></personal_name>
<personal_reading><part>こじんめい-modified</part></personal_reading>
</card>
</modify_card>
</parameters>
|
レスポンス
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<returns>
<card book_id="1" id="1" version="1281487669"
xmlns:card="http://schemas.cybozu.co.jp/address/2008">
<card:creator user_id="1" name="Administrator" date="2010-08-11T00:31:18Z" />
<card:modifier user_id="1" name="Administrator" date="2010-08-11T00:47:49Z" />
<card:subject>アドレス帳タイトル - modified</card:subject>
<card:personal_name>
<card:part>個人名-modified</card:part>
<card:part></card:part>
</card:personal_name>
<card:personal_reading>
<card:part>こじんめい-modified</card:part>
<card:part></card:part>
</card:personal_reading>
</card>
</returns>
|
エラー
エラー番号 |
説明 |
GRN_UTIL_API_65009 |
アップロードするファイルのサイズが、Base64 エンコード後で 300MB より大きい場合 |
共有アドレス帳のアドレスを削除する
共有アドレス帳の ID と削除するアドレスの ID をリクエストのパラメーターとして受け取り、共有アドレス帳からアドレスを削除する API です。
API名
AddressRemoveSharedCards
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
例
1
2
3
|
<parameters book_id="1">
<card_id>1</card_id>
</parameters>
|
レスポンス
なし
個人アドレス帳のアドレスを削除する
削除するアドレスの ID をリクエストのパラメーターとして受け取り、削除する API です。
API名
AddressRemovePersonalCards
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
パラメーター名 |
型 |
パラメーター数 |
説明 |
card_id/text() |
base:IDType |
1 ~ 無制限 |
削除するアドレスのID |
例
1
2
3
|
<parameters>
<card_id>1</card_id>
</parameters>
|
レスポンス
なし
アドレスを移動する
移動するアドレス情報をリクエストのパラメーターとして受け取り、移動処理を実行後、移動したアドレス情報をレスポンスとして返す API です。閲覧できない book_id を指定した場合、空のレスポンスが返されます。
API名
AddressCopyPersonalCardsToOtherBook
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
例
1
2
3
|
<parameters>
<copy_item copied_book_id="1" card_id="2"></copy_item>
</parameters>
|
レスポンス
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<returns>
<card book_id="1" id="3" version="1281489220" xmlns:card="http://schemas.cybozu.co.jp/address/2008">
<card:creator user_id="1" name="Administrator" date="2010-08-11T01:13:40Z" />
<card:modifier user_id="1" name="Administrator" date="2010-08-11T01:13:40Z" />
<card:subject>こじんあどれす</card:subject>
<card:personal_name>
<card:part>伊藤</card:part>
<card:part>太郎</card:part>
</card:personal_name>
<card:personal_reading>
<card:part>いとう</card:part>
<card:part>たろう</card:part>
</card:personal_reading>
</card>
</returns>
|