グループ情報API

Overview

本APIはグループID、グループ名などのグループに紐づく情報を閲覧/登録/変更/削除することができます。

-グループ情報API(情報照会)
-グループ情報API(登録)
-グループ情報API(更新)
-グループ情報API(削除)

 グループ情報API(情報照会)

GET https://api.ntt.com/v1/anpi/maintenance/group/

団体内に登録されているグループ情報を取得します。
一度に取得できる情報は最大1,000件までとなります。

Request Parameters

URL Path Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
grpid グループID 半角数字 7
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

GET https://api.ntt.com/v1/anpi/maintenance/group/?grpid=xxxxx&limit=10

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
[grpList] グループ一覧 - - - 検索結果数分、以下の情報を設定する。
-grpid グループID 半角数字 7
-grpnm グループ名称 全半角 40
-[usrcdList] グループメンバー一覧 - - - グループに登録されているメンバー数分、以下の情報を設定する。
--usrcd 氏名コード 半角英数字 32
--staffsei 氏名(姓) 全半角 32
--staffmei 氏名(名) 全半角 32
-[mgrcdList] グループ管理者一覧 - - - グループに登録されている管理者数分、以下の情報を設定する。
--usrcd 氏名コード 半角英数字 32
--staffsei 氏名(姓) 全半角 32
--staffmei 氏名(名) 全半角 32

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{   
  "searchTotal": 2000,  
  "searchCount": 10,    
  "nextOffset": 10, 
  "useCount": 4365762,  
  "contractCount": -1,  
  "grpList": [  
    {   
      "grpid": "0001",  
      "grpnm": "1stグループ",
      "usrcdList": [    
        {
         "usrcd": "0001",   
         "staffsei": "安否",  
         "staffmei": "太郎"
        }
      ] 
      "mgrcdList": [    
       {
         "usrcd": "0002",   
         "staffsei": "安否",  
         "staffmei": "次郎"   
        }
      ] 
    }   
 ]  
}

戻る

 グループ情報API(登録)

POST https://api.ntt.com/v1/anpi/maintenance/group/

団体にグループ情報を登録します。
一度に登録できる情報は最大1,000件までとなります。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
[grpList] グループ情報一覧 - - 登録数分、以下の情報を設定する。
-grpnm グループ名称 全半角 40
-[usrcdList] グループメンバー一覧 - - - 配列
氏名コード 半角英数字 32 登録数分設定する。
-[mgrcdList] グループ管理者一覧 - - 配列
氏名コード 半角英数字 32 登録数分設定する。

Example Request

POST https://api.ntt.com/v1/anpi/maintenance/group/
{
    "grpList": [
        {
            "grpnm": "グループA",
            "usrcdList": [
              "007100nttdatacs"
            ],
            "mgrcdList ": [
              "007100nttdatacs"
            ]
        }
    ]
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
resultCount 処理結果件数 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
[grpList] グループ一覧 - - 検索結果数分、以下の情報を設定する。
-grpid グループID 半角数字 7
-grpnm グループ名称 全半角 40

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "resultCount": 1,
  "useCount": 8,
  "contractCount": -1,
  "grpList": [  
    {   
      "grpid": "0001",  
      "grpnm": "1stグループ"
    }   
 ]  
}

戻る

 グループ情報API(更新)

PUT https://api.ntt.com/v1/anpi/maintenance/group/

団体のグループ情報を更新します。
一度に更新できる情報は最大1,000件までとなります。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
[grpList] グループ情報一覧 - - 更新数分、以下の情報を設定する。
-grpid グループID 半角数字 7
-grpnm グループ名称 全半角 40
-[usrcdList] グループメンバー一覧 - - - 配列
氏名コード 半角英数字 32 更新数分設定する。
-[mgrcdList] グループ管理者一覧 - - 配列
氏名コード 半角英数字 32 更新数分設定する。※グループ管理者一覧が設定されている場合、必須

Example Request

PUT https://api.ntt.com/v1/anpi/maintenance/group/
{
    "grpList": [
        {
            "grpid": "0001",
            "grpnm": "グループABC",
            "usrcdList": [
              "007100nttdatacs"
            ],
            "mgrcdList ": [
              "007100nttdatacs"
            ]
        }
    ]
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
resultCount 処理結果件数 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "resultCount": 1,
  "useCount": 8,
  "contractCount": -1
}

戻る

 グループ情報API(削除)

DELETE https://api.ntt.com/v1/anpi/maintenance/group/

団体のグループ情報を削除します。
一度に削除できる情報は最大1,000件までとなります。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
[grpidList] グループパス一覧 - - 配列
グループID 半角数字 7 削除数分設定する。

Example Request

DELETE https://api.ntt.com/v1/anpi/maintenance/group/
{
    "grpidList": [
        "1000"
    ]
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
resultCount 処理結果件数 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "resultCount": 1,
  "useCount": 8,
  "contractCount": -1
}

戻る