Garoon API ドキュメント

アドレス帳APIで使用するデータの構造

目次

CardType

固定リンクがコピーされました

アドレスを表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
creator base:ChangeLogType 1 作成者情報を保持する要素
modifier base:ChangeLogType 0 ～ 1
0：更新情報が存在しない
1：更新情報が存在する
 最終更新者の情報を保持する要素
subject/text() xsd:string 1 標題
personal_name address:NameFieldValueType
 0 ～ 1
0：個人名が指定されていない
1：個人名が指定されている
 個人名を保持する要素
personal_reading address:NameFieldValueType 0 ～ 1
0：個人名（よみ）が指定されていない
1：個人名（よみ）が指定されている
 個人名（よみ）を保持する要素
company_name/text() xsd:string 0 ～ 1
0：会社名が指定されていない
1：会社名が指定されている
 会社名
company_reading/text() xsd:string 0 ～ 1
0：会社名（よみ）が指定されていない
1：会社名（よみ）が指定されている
 会社名（よみ）
section/text() xsd:string 0 ～ 1
0：部課名が指定されていない
1：部課名が指定されている
 部課名
zip_code/text() xsd:string 0 ～ 1
0：郵便番号が指定されていない
1：郵便番号が指定されている
 郵便番号
physical_address/text() xsd:string 0 ～ 1
0：住所が指定されていない
1：住所が指定されている
 住所
map/text() xsd:anyURI 0 ～ 1
0：地図が指定されていない
1：地図が指定されている
 地図
route address:RouteFieldValueType 0 ～ 1
0：路線情報が指定されていない
1：路線情報が指定されている
 路線情報
company_tel/text() xsd:string 0 ～ 1
0：会社電話番号が指定されていない
1：会社電話番号が指定されている
 会社電話番号
company_fax/text() xsd:string 0 ～ 1
0：会社FAX番号が指定されていない
1：会社FAX番号が指定されている
 会社FAX番号
url/text() xsd:anyURI 0 ～ 1
0：URLが指定されていない
1：URLが指定されている
 URL
post/text() xsd:string 0 ～ 1
0：役職名が指定されていない
1：役職名が指定されている
 役職名
personal_tel/text() xsd:string 0 ～ 1
0：個人電話番号が指定されていない
1：個人電話番号が指定されている
 個人電話番号
email/text() xsd:string 0 ～ 1
0：E-mailが指定されていない
1：E-mailが指定されている
 E-mail
image address:FileFieldValueType 0 ～ 1
0：画像情報が指定されていない
1：画像情報が指定されている
 画像情報を保持する要素
description/text() xsd:string 0 ～ 1
0：メモが指定されていない
1：メモが指定されている
 メモ
custom 配列 0 ～ 1
0：カスタマイズ項目が指定されていない
1：カスタマイズ項目が指定されている
 カスタマイズ項目を保持する要素
custom/string address:StringFieldValueType 0 ～ 無制限
0：文字列（1行）項目が指定されていない
 文字列（1行）項目を保持する要素
custom/string/@field_code base:NonBlankStringType 1 文字列（1行）項目のID
custom/text address:TextFieldValueType 0 ～ 無制限
0：文字列（複数行）項目が指定されていない
 文字列（複数行）項目を保持する要素
cutom/text/@field_code base:NonBlankStringType 1 文字列（複数行）のID
custom/url address:UrlFieldValueType 0 ～ 無制限
0：URL項目が指定されていない
 URL項目を保持する要素
custom/url/@image xsd:boolean 1
  • true：画像URLである
  • false：画像URLでない
custom/url/@field_code base:NonBlankStringType 1 URL項目のID
custom/file address:FileFieldValueType 0 ～ 無制限
0：ファイル項目が指定されていない
 ファイル項目を保持する要素
custom/file/@field_code base:NonBlankStringType 1 ファイル項目のID
custom/ipphone address:IPPhoneFieldValueType 0 ～ 無制限
0：IP電話項目が指定されていない
 IP電話項目を保持する要素
custom/ipphone/@field_code base:NonBlankStringType 1 IP電話項目のID
@book_id base:IDType 1 アドレスが属するアドレス帳のID。個人アドレス帳の場合、book_idは「-1」になります。
@id base:IDType 1 アドレスのID
@version base:VersionType 1 アドレスの更新日時のタイムスタンプ

NameFieldValueType

固定リンクがコピーされました

名前項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
part/text() xsd:string 2 1つ目：姓2つ目：名

RouteFieldValueType

固定リンクがコピーされました

路線項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
path/text() xsd:string 0 ～ 1
  • 0：経路が指定されていない
  • 1：経路が指定されている
 経路
time/text() xsd:string 0 ～ 1
  • 0：所要時間が指定されていない
  • 1：所要時間が指定されている
 所要時間
fare/text() xsd:string 0 ～ 1
  • 0：運賃が指定されていない
  • 1：運賃が指定されている
 運賃

StringFieldValueType

固定リンクがコピーされました

文字列（1行）項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
text() xsd:string 1 文字列（1行）項目の値

TextFieldValueType

固定リンクがコピーされました

文字列（複数行）項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
text() xsd:string 1 文字列（複数行）項目の値

URLFieldValueType

固定リンクがコピーされました

URL項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
text() xsd:anyURI 1 URL項目の値

FileFieldValueType

固定リンクがコピーされました

ファイル項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
custom/file/@name base:NonBlankStringType 1 ファイル名
custom/file/@file_id base:IDType 1 ファイルID
custom/file/@size xsd:unsignedLong 1 ファイルのサイズ
custom/@mime_type xsd:string 1 ファイルのMIMEタイプ

IPPhoneFieldValueType

固定リンクがコピーされました

IP電話項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
text() xsd:string 1 IP電話項目の値

BookType

固定リンクがコピーされました

ブックを表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明 変更履歴
form address:FormConfigType 1 ブック項目の一覧
cards 配列 1 ブックに登録されているアドレス一覧
cards/card - 0 ～ 無制限
  • 0：アドレス情報が存在しない
 アドレス情報を保持する要素
cards/card/@id base:IDType 1 アドレスのID
@key base:IDType 1 ブックのコード
@book_id base:IDType 1 ブックのID パッケージ版 Garoon 3.1 で追加
@name base:NonBlankStringType 1 ブック名
@type base:NonBlankStringType 1 ブックタイプ
@version base:VersionType 1 ブックの更新日時のタイムスタンプ

FormConfigType

固定リンクがコピーされました

ブックの各項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
subject address:FieldConfigType 1 標題項目
personal_name address:NameFieldConfigType 0 ～ 1
  • 個人名項目を使用しない
  • 個人名の項目を使用する
 個人名の項目
personal_reading address:NameFieldConfigType 0 ～ 1
  • 個人名（よみ）の項目を使用しない
  • 個人名（よみ）の項目を使用する
 個人名（よみ）の項目
company_name address:FieldConfigType 0 ～ 1
  • 会社名項目を使用しない
  • 会社名の項目を使用する
 会社名の項目
company_reading address:FieldConfigType 0 ～ 1
  • 会社名（よみ）の項目を使用しない
  • 会社名（よみ）の項目を使用する
 会社名（よみ）の項目
section address:FieldConfigType 0 ～ 1
  • 部課名の項目を使用しない
  • 部課名の項目を使用する
 部課名の項目
zip_code address:FieldConfigType 0 ～ 1
  • 郵便番号の項目を使用しない
  • 郵便番号の項目を使用する
 郵便番号の項目
physical_address address:FieldConfigType 0 ～ 1
  • 住所項目を使用しない
  • 住所の項目を使用する
 住所の項目
map address:FieldConfigType 0 ～ 1
  • 地図項目を使用しない
  • 地図項目を使用する
 地図項目
route address:FieldConfigType 0 ～ 1
  • 路線情報の項目を使用しない
  • 路線情報の項目を使用する
 路線情報の項目
route_detail address:FieldConfigType 0 ～ 1
  • 経路情報の項目を使用しない
  • 経路情報の項目を使用する
 経路情報の項目
company_tel address:FieldConfigType 0 ～ 1
  • 会社電話番号の項目を使用しない
  • 会社電話番号の項目を使用する
 会社電話番号の項目
company_fax address:FieldConfigType 0 ～ 1
  • 会社FAX番号の項目を使用しない
  • 会社FAX番号の項目を使用する
 会社FAX番号の項目
url address:FieldConfigType 0 ～ 1
  • URLの項目を使用しない
  • URLの項目を使用する
 URLの項目
post address:FieldConfigType 0 ～ 1
  • 役職名の項目を使用しない
  • 役職名の項目を使用する
 役職名の項目
personal_tel address:FieldConfigType 0 ～ 1
  • 個人電話番号の項目を使用しない
  • 個人電話番号の項目を使用する
 個人電話番号の項目
email address:FieldConfigType 0 ～ 1
  • E-mailの項目を使用しない
  • E-mailの項目を使用する
 E-mailの項目
image address:FieldConfigType 0 ～ 1
  • 画像情報の項目を使用しない
  • 画像情報の項目を使用する
 画像情報の項目
description address:FieldConfigType 0 ～ 1
  • メモの項目を使用しない
  • メモの項目を使用する
 メモの項目
custom 配列 0 ～ 1
  • 使用するカスタマイズ項目が存在しない
  • 使用するカスタマイズ項目が存在する
 カスタマイズ項目を保持する要素
custom/string address:FieldConfigType 0 ～ 無制限
  • 0：使用する文字列（1行）カスタマイズ項目が存在しない
 文字列（1行）カスタマイズ項目
custom/text address:FieldConfigType 0 ～ 無制限
  • 0：使用する文字列（複数行）カスタマイズ項目が存在しない
 文字列（複数行）カスタマイズ項目
custom/url address:UrlFieldConfigType 0 ～ 無制限
  • 0：使用するURLカスタマイズ項目が存在しない
 URLカスタマイズ項目
custom/file address:FieldConfigType 0 ～ 無制限
  • 0：使用する添付ファイルカスタマイズ項目が存在しない
 添付ファイルカスタマイズ項目
custom/ipphone address:FieldConfigType 0 ～ 無制限
  • 0：使用するIP電話カスタマイズ項目が存在しない
 IP電話カスタマイズ項目
@key base:IDType 1 項目ID
@version base:VersionType 1 項目の更新日時のタイムスタンプ

FieldConfigType

固定リンクがコピーされました

項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@name base:NonBlankStringType 1 項目の表示名
@field_code base:NonBlankStringType 1 項目のコード
@using xsd:boolean 0 ～ 1 項目の使用
  • true：する
  • false：しない
@listing xsd:boolean 0 ～ 1 項目を標準で表示
  • true：する
  • false：しない
@necessary xsd:boolean 0 ～ 1
  • 必須項目
  • 必須項目でない
@allow_modification xsd:boolean 0 ～ 1 項目をユーザーが変更
  • true：可
  • false：不可
@sso_id xsd:string 1 シングルサインオン方式ID

UrlFieldConfigType

固定リンクがコピーされました

URLカスタマイズ項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@name base:NonBlankStringType 1 項目の表示名
@field_code base:NonBlankStringType 1 項目のコード
@using xsd:boolean 0 ～ 1 項目の使用
  • true：する
  • false：しない
@listing xsd:boolean 0 ～ 1 項目を標準で表示
  • true：する
  • false：しない
@necessary xsd:boolean 0 ～ 1
  • 必須項目
  • 必須項目でない
@allow_modification xsd:boolean 0 ～ 1 項目をユーザーが変更
  • true：可
  • false：不可
@sso_id xsd:string 1 シングルサインオン方式ID
@image xsd:boolean 0 ～ 1
  • true：画像URL項目
  • false：URL項目
初期値はfalse

MyAddressGroupType

固定リンクがコピーされました

Myアドレスグループを表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 MyアドレスグループのID
@version base:VersionType 1 Myアドレスグループのバージョン情報
@name base:NonBlankStringType 1 グループ名
@description xsd:string 0 ～ 1 メモ
user - 0 ～ 無制限 グループに属するユーザー
user/@key base:IDType 1 ユーザーのID
card - 0 ～ 無制限 グループに属するアドレス
card/@key base:IDType 1 アドレスのID
card/@type xsd:string 1 「shared」または「private」を取り得る。
  • shared：共有アドレス帳のアドレス
  • private：個人アドレス帳のアドレス

AddressCopyItemType

固定リンクがコピーされました

個人アドレス帳から他のアドレス帳へアドレスをコピーする際に使用する型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@copied_book_id base:IDType 1 コピー先のアドレス帳のID
@card_id base:IDType 1 コピーするアドレスのID

AddressCardContainsFileType

固定リンクがコピーされました

ファイルを含むアドレス情報を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
card address:CardType 1 アドレス情報
file - 0 ～ 無制限 添付ファイル
file/@id base:IDType 1 ファイルID
file/content/text() xsd:base64Binary 1 ファイル内容

NameFieldConfigType

固定リンクがコピーされました

個人名、および個人名（よみ）項目を表す型です。

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

固定リンクがコピーされました

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

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@name base:NonBlankStringType 1 項目の表示名
@field_code base:NonBlankStringType 1 項目のコード
@using xsd:boolean 0 ～ 1 項目の使用
  • true：する
  • false：しない
@listing xsd:boolean 0 ～ 1 項目を標準で表示
  • true：する
  • false：しない
@necessary xsd:boolean 0 ～ 1
  • 必須項目
  • 必須項目でない
@allow_modification xsd:boolean 0 ～ 1 項目をユーザーが変更
  • true：可
  • false：不可
@sso_id xsd:string 1 シングルサインオン方式ID
@number_of_parts xsd:positiveInteger 0 ～ 1 Garoonでは未使用