Myアドレスグループを取得/登録/更新/削除する

目次

Myアドレスグループの更新情報を取得する

Myアドレスグループのバージョンをリクエストのパラメーターとして受け取り、Myアドレスグループの更新情報をレスポンスとして返すAPIです。

API名

AddressGetMyAddressGroupVersions

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
my_address_group_item base:ItemVersionType 0~ 無制限 取得するMyアドレスグループのバージョン
1
2
3
<parameters>
  <my_address_group_item id="1" version="1281490000"></my_address_group_item> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
my_address_group_item base:ItemVersionResultType 0~ 無制限 Myアドレスグループの更新情報
1
2
3
4
<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
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
my_address_group_id/text() base:IDType 1~ 無制限 取得するMyアドレスグループのID
1
2
3
<parameters> 
  <my_address_group_id>1</my_address_group_id> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
my_address_group address:MyAddressGroupType 0~ 無制限 Myアドレスグループの情報
1
2
3
<returns>
  <my_address_group id="1" name="group1" version="1281490026" ></my_address_group> 
</returns>

Myアドレスグループを追加する

追加するMyアドレスグループをリクエストのパラメーターとして受け取り、追加処理を実行後、追加したMyアドレスグループの情報をレスポンスとして返すAPIです。

API名

AddressAddMyAddressGroups

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
my_address_group address:MyAddressGroupType 1~ 無制限 追加するMyアドレスグループ
1
2
3
<parameters>
  <my_address_group id="dummy" version="dummy" name="アドレスグループ" description="テストアドレスグループ"></my_address_group>
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
my_address_group address:MyAddressGroupType 0~ 無制限 追加したMyアドレスグループ
1
2
3
4
<returns>
  <my_address_group id="3" name="アドレスグループ"
   version="1281491290" description="テストアドレスグループ" />
</returns>

Myアドレスグループを更新する

更新するMyアドレスグループをリクエストのパラメーターとして受け取り、更新処理を実行後、更新されたMyアドレスグループの情報をレスポンスとして返すAPIです。

API名

AddressModifyMyAddressGroups

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
my_address_group address:MyAddressGroupType 1~ 無制限 更新するMyアドレスグループ
1
2
3
<parameters>
  <my_address_group xmlns="" id="3" version="dummy" name="アドレスグループ-modified" description="テストアドレスグループ-modified"></my_address_group>
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
my_address_group address:MyAddressGroupType 0~ 無制限 変更したMyアドレスグループ
1
2
3
4
<returns>
  <my_address_group id="3" name="アドレスグループ-modified"
   version="1281491290" description="テストアドレスグループ-modified" />
</returns>

Myアドレスグループを削除する

削除するMyアドレスグループのIDをリクエストのパラメーターとして受け取り、削除するAPIです。

API名

AddressRemoveMyAddressGroups

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
my_address_group_id/text() base:IDType 1~ 無制限 削除するMyアドレスグループのID
1
2
3
<parameters>
  <my_address_group_id xmlns="">1</my_address_group_id>
</parameters>

レスポンス

なし

Myアドレスグループのアドレスを変更する

変更するMyアドレスグループ、およびアドレスの情報をリクエストのパラメーターとして受け取り、変更したMyアドレスグループの情報をレスポンスとして返すAPIです。

API名

AddressModifyCardsInMyAddressGroup

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
my_address_group address:MyAddressGroupType 0~ 無制限 変更するMyアドレスグループの情報
1
2
3
4
5
6
<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アドレスグループの情報
1
2
3
4
5
6
<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>