Index
Myアドレスグループの更新情報を取得する
My アドレスグループのバージョンをリクエストのパラメーターとして受け取り、My アドレスグループの更新情報をレスポンスとして返す API です。
API名
AddressGetMyAddressGroupVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group_item | base:ItemVersionType | 0 ～ 無制限 | 取得するMyアドレスグループのバージョン |
例
<parameters> <my_address_group_item id="1" version="1281490000"></my_address_group_item> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group_item | base:ItemVersionResultType | 0 ～ 無制限 | Myアドレスグループの更新情報 |
例
<returns> <my_address_group_item id="1" version="1281490026" operation="modify" /> <my_address_group_item id="2" version="1281490032" operation="add" /> </returns>
Myアドレスグループ情報を取得する
My アドレスグループの ID をリクエストのパラメーターとして受け取り、My アドレスグループの情報をレスポンスとして返す API です。
API名
AddressGetMyAddressGroupsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group_id/text() | base:IDType | 1 ～ 無制限 | 取得するMyアドレスグループのID |
例
<parameters> <my_address_group_id>1</my_address_group_id> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 0 ～ 無制限 | Myアドレスグループの情報 |
例
<returns> <my_address_group id="1" name="group1" version="1281490026" ></my_address_group> </returns>
Myアドレスグループを追加する
追加する My アドレスグループをリクエストのパラメーターとして受け取り、追加処理を実行後、追加した My アドレスグループの情報をレスポンスとして返す AIP です。
API名
AddressAddMyAddressGroups
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 1 ～ 無制限 | 追加するMyアドレスグループ |
例
<parameters> <my_address_group id="dummy" version="dummy" name="アドレスグループ" description="テストアドレスグループ"></my_address_group> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 0 ～ 無制限 | 追加したMyアドレスグループ |
例
<returns> <my_address_group id="3" name="アドレスグループ" version="1281491290" description="テストアドレスグループ" /> </returns>
Myアドレスグループを更新する
更新する My アドレスグループをリクエストのパラメーターとして受け取り、更新処理を実行後、更新された My アドレスグループの情報をレスポンスとして返す API です。
API名
AddressModifyMyAddressGroups
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 1 ～ 無制限 | 更新するMyアドレスグループ |
例
<parameters> <my_address_group xmlns="" id="3" version="dummy" name="アドレスグループ-modified" description="テストアドレスグループ-modified"></my_address_group> </parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 0 ～ 無制限 | 変更したMyアドレスグループ |
例
<returns> <my_address_group id="3" name="アドレスグループ-modified" version="1281491290" description="テストアドレスグループ-modified" /> </returns>
Myアドレスグループを削除する
削除する My アドレスグループの ID をリクエストのパラメーターとして受け取り、削除する API です。
API名
AddressRemoveMyAddressGroups
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group_id/text() | base:IDType | 1 ～ 無制限 | 削除するMyアドレスグループのID |
例
<parameters> <my_address_group_id xmlns="">1</my_address_group_id> </parameters>
レスポンス
なし
Myアドレスグループのアドレスを変更する
変更するMyアドレスグループ、及びアドレスの情報をリクエストのパラメーターとして受け取り、変更したMyアドレスグループの情報をレスポンスとして返すAPIです。
API名
AddressModifyCardsInMyAddressGroup
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 0 ～ 無制限 | 変更するMyアドレスグループの情報 |
例
<parameters>
<my_address_group id="1">
<user key="3"></user>
<card key="2" type="shared"></card>
</my_address_group>
</parameters>
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
| my_address_group | address:MyAddressGroupType | 0 ～ 無制限 | 変更したMyアドレスグループの情報 |
例
<returns>
<my_address_group id="1" name="group1" version="1281492637" >
<user key="1" xmlns="http://schemas.cybozu.co.jp/address/2008" />
<card key="2" type="shared" xmlns="http://schemas.cybozu.co.jp/address/2008" />
</my_address_group>
</returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。