グループ情報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、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

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

Response Parameters

正常時

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

異常時

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

Example Result

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

戻る

　グループ情報API（登録）

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

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

Request Parameters

Body json Parameter

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

Example Request

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

Response Parameters

正常時

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

異常時

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

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、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

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

Response Parameters

正常時

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

異常時

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

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、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

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

Response Parameters

正常時

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

異常時

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

Example Result

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

戻る