個人情報API

Overview

本APIは名前、所属、連絡先などの個人に紐づく情報を閲覧/登録/変更/削除することができます。
「都道府県コード」「地域コード」の具体的な値の一覧はユーザマニュアルをご参照ください。
-個人情報API（情報照会）
-個人情報API（登録）
-個人情報API（更新）
-個人情報API（削除）

　個人情報API（情報照会）

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

団体内に登録されているユーザ情報を取得します。
一度に取得できる情報は5,000件までとなります。

Request Parameters

URL Path Parameter

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

Example Request

GET https://api.ntt.com/v1/anpi/maintenance/user/?orgpath=/&sei=xxxxxx

Response Parameters

正常時

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

※アクセス権限フラグ（accflg）の具体値
○管理権限
（組織管理者：管理メニューとメンテナンスメニューを利用可能、データ管理者：メンテナンスメニューを利用可能）

○一般権限

異常時

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

Example Result

{   
  "searchTotal": 200000,    
  "searchCount": 10,    
  "nextOffset": 10, 
  "useCount": 4365762,  
  "contractCount": -1,  
  "usrList": [  
    {   
      "usrcd": "usr000001", 
      "indpflg": "0",   
      "orgpath": "/1stAAAA00001/",  
      "orgpathnm": "1st組織00001",    
      "accflg": "5",    
      "addorgList": null,   
      "kanasei": "アンピ", 
      "kanamei": "ハナコ", 
      "staffsei": "安否", 
      "staffmei": "花子", 
      "langcd": "ja",   
      "ctmcd": "ctmcd00001",    
      "ctmnm": "A地方(00001)",    
      "wktdfkcd": "36", 
      "wkareacd": "111",    
      "wkskcs": "B市",   
      "wkaddbnc": "3-5-1",  
      "lcncd": "lcncd00001",    
      "lcnnm": "C県あま市乙之子(00001)",   
      "ad1tdfkcd": "15",    
      "ad1areacd": "222",
      "ad1skcs": "D市E村",    
      "ad1bnc": "4-3-9",    
      "ad2tdfkcd": "23",    
      "ad2areacd": "333",
      "ad2skcs": "B市F町",    
      "ad2bnc": "1-16-7",   
      "tel1": null, 
      "tel1odr": 2, 
      "tel2": null, 
      "tel2odr": 3, 
      "tel3": null, 
      "tel3odr": 4, 
      "mail1": "anpi@jm04-anpi.com",    
      "mail2": "anpi@jm05-anpi.com",    
      "mail3": "anpi@jm06-anpi.com",    
      "mailodr": 1, 
      "rsvtel": "000000000000", 
      "rsvmail": "dummy@dummy.dummy.dummy", 
      "priority": 5,    
      "certify": "1",   
      "kojinmtdispflg": null    
    },  
     {  
      "usrcd": "usr000002", 
      "indpflg": "0",   
      "orgpath": "/1stAAAA00001/",  
      "orgpathnm": "1st組織00001",    
      "accflg": "5",    
      "addorgList": null,   
      "kanasei": "アンピ", 
      "kanamei": "タロウ", 
      "staffsei": "安否", 
      "staffmei": "太郎", 
      "langcd": "ja",   
      "ctmcd": "ctmcd00001",    
      "ctmnm": "G地区(00001)",    
      "wktdfkcd": "36", 
      "wkareacd": "111",    
      "wkskcs": "R市",   
      "wkaddbnc": "3-5-1",  
      "lcncd": "lcncd00001",    
      "lcnnm": "K県K市中央(00001)", 
      "ad1tdfkcd": "15",    
      "ad1areacd": "222",   
      "ad1skcs": "O市",  
      "ad1bnc": "4-3-9",    
      "ad2tdfkcd": "23",    
      "ad2areacd": "333",   
      "ad2skcs": "I市PP町",   
      "ad2bnc": "1-16-7",   
      "tel1": null, 
      "tel1odr": 2, 
      "tel2": null, 
      "tel2odr": 3, 
      "tel3": null, 
      "tel3odr": 4, 
      "mail1": "anpi@jm04-anpi.com",    
      "mail2": "anpi@jm05-anpi.com",    
      "mail3": "anpi@jm06-anpi.com",    
      "mailodr": 1, 
      "rsvtel": "000000000000", 
      "rsvmail": "dummy@dummy.dummy.dummy", 
      "priority": 5,    
      "certify": "1",   
      "kojinmtdispflg": null    
    }   
 ]  
}

戻る

　個人情報API（登録）

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

団体にユーザ情報を登録します。
一度に登録できる情報は5,000件までとなります。

Request Parameters

Body json Parameter

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

※１　MAIL、TELの順序が指定されない場合、デフォルト順序は１：MAIL、２：TEL1、３：TEL2、４：TEL3とする

Example Request

POST https://api.ntt.com/v1/anpi/maintenance/user/
{
    "usrList": [
        {
            "usrcd": 50000,
            "indpflg": 1,
            "accflg": 5,
            "kanasei": "ユーザー",
            "kanamei": "エーピーアイ",
            "staffsei": "API",
            "staffmei": 50000,
            "langcd": "ja",
            "wktdfkcd": "01",
            "wkareacd": "111",
            "wkskcs": "Y市",
            "wkaddbnc": "O区",
            "ad1tdfkcd": "01",
            "ad1areacd": "222",
            "ad1skcs": "O市",
            "ad1bnc": "Y区",
            "ad2tdfkcd": "01",
            "ad2areacd": "333",
            "ad2skcs": "O市",
            "ad2bnc": "C区",
            "mail1": "anpi-anpi@intas-anpi.com",
            "mailodr": 1,
            "priority": 5,
            "bscpassword": "pwd50000",
            "kojinmtdispflg": 0
        }
    ]
}

Response Parameters

正常時

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

異常時

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

Example Result

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

戻る

　個人情報API（更新）

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

団体のユーザ情報を更新します。
一度に更新できる情報は5,000件までとなります。

Request Parameters

Body json Parameter

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

Example Request

PUT https://api.ntt.com/v1/anpi/maintenance/user/
{
    "usrList": [
        {
            "usrcd": 50000,
            "indpflg": 1,
            "accflg": 5,
            "kanasei": "ユーザー",
            "kanamei": "エーピーアイ",
            "staffsei": "API",
            "staffmei": 50000,
            "langcd": "ja",
            "wktdfkcd": "01",
            "wkareacd": "111",
            "wkskcs": "O市",
            "wkaddbnc": "P区",
            "ad1tdfkcd": "01",
            "ad1areacd": "222",
            "ad1skcs": "P市",
            "ad1bnc": "I区",
            "ad2tdfkcd": "01",
            "ad2areacd": "333",
            "ad2skcs": "RR市",
            "ad2bnc": "P区",
            "mail1": "anpi-anpi@intas-anpi.com",
            "mailodr": 1,
            "priority": 5,
            "bscpassword": "pwd50000",
            "kojinmtdispflg": 0
        }
    ]
}

Response Parameters

正常時

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

異常時

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

Example Result

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

戻る

　個人情報API（削除）

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

団体のユーザ情報を削除します。
一度に削除できる情報は5,000件までとなります。

Request Parameters

Body json Parameter

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

Example Request

DELETE https://api.ntt.com/v1/anpi/maintenance/user/
{
    "usrcdList": [
        50000
    ]
}

Response Parameters

正常時

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

異常時

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

Example Result

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

戻る