個人情報API

Overview

本APIは名前、所属、連絡先などの個人に紐づく情報を閲覧/登録/変更/削除することができます。
-個人情報API(情報照会)
-個人情報API(登録)
-個人情報API(更新)
-個人情報API(削除)

 個人情報API(情報照会)

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

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

Request Parameters

URL Path Parameter

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

項目 名称 桁数 必須 備考
orgpath 組織パス 半角英数字記号 331 所属なしを検索する場合は、「/」を指定する
usrcd 氏名コード 半角英数字 32
sei 氏名(姓/セイ) 全半角 32
mei 氏名(名/メイ) 全半角 32
ctmcd ユーザ設定コード 半角英数字 32
accflg アクセス権限 半角数字 1 0:管理者/1:一般
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

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

Response Parameters

正常時

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

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
[usrList] 個人情報一覧 - - - 検索結果数分、以下の情報を設定する
-usrcd 氏名コード 半角英数字 32
-indpflg 所属有無 半角数字 1 0:所属あり/1:所属なし
-orgpath 本務組織パス 半角英数字記号 331
-orgpathnm 本務組織パス名称 全半角 627
-accflg 本務アクセス権限 半角英数字 1 アクセス権限フラグの値を返却
-[addorgList] 兼務組織一覧 - - - 最大4件
--orgpath 兼務組織パス 半角英数字記号 331
--orgpathnm 兼務組織パス名称 全半角 627
--accflg 兼務アクセス権限 半角英数字 1 アクセス権限フラグの値を返却
-kanasei カナ姓 全角カタカナ 32
-kanamei カナ名 全角カタカナ 32
-staffsei 全半角 32
-staffmei 全半角 32
-langcd 言語コード 半角英数字 2 'ja':日本語/'en':英語
-ctmcd ユーザ設定コード 半角英数字 32
-ctmnm ユーザ設定コード名称 全半角 40
-wktdfkcd 勤務先住所都道府県コード 半角数字 2 都道府県コードを返却
-wkskcs 勤務先住所市区町村 全半角 40
-wkaddbnc 勤務先住所番地 全半角 80
-lcncd ロケーションコード 半角英数字 32
-lcnnm ロケーション名称 全半角 40
-ad1tdfkcd 住所1都道府県コード 半角数字 2 都道府県コードを返却
-ad1skcs 住所1市区町村 全半角 40
-ad1bnc 住所1番地 全半角 80
-ad2tdfkcd 住所2都道府県コード 半角数字 2 都道府県コードを返却
-ad2skcs 住所2市区町村 全半角 40
-ad2bnc 住所2番地 全半角 80
-tel1 連絡先TEL1 半角数字 15
-tel1odr 連絡先TEL順序1 半角数字 1
-tel2 連絡先TEL2 半角数字 15
-tel2odr 連絡先TEL順序2 半角数字 1
-tel3 連絡先TEL3 半角数字 15
-tel3odr 連絡先TEL順序3 半角数字 1
-mail1 連絡先MAIL1 メール形式 100
-mail2 連絡先MAIL2 メール形式 100
-mail3 連絡先MAIL3 メール形式 100
-mailodr 連絡先MAIL順序 半角数字 1
-rsvtel 予備TEL 半角数字 15
-rsvmail 予備MAIL メール形式 100
-priority 送信優先順位 半角数字 1 1:高い~5:普通~9:低い
-certify 音声認証用個人ID 半角数字 32
-kojinmtdispflg 個人メンテナンス非表示使用フラグ 半角数字 1 0:未使用/1:使用

異常時

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

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

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", 
      "wkskcs": "B市",   
      "wkaddbnc": "3-5-1",  
      "lcncd": "lcncd00001",    
      "lcnnm": "C県あま市乙之子(00001)",   
      "ad1tdfkcd": "15",    
      "ad1skcs": "D市E村",    
      "ad1bnc": "4-3-9",    
      "ad2tdfkcd": "23",    
      "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", 
      "wkskcs": "R市",   
      "wkaddbnc": "3-5-1",  
      "lcncd": "lcncd00001",    
      "lcnnm": "K県K市中央(00001)", 
      "ad1tdfkcd": "15",    
      "ad1skcs": "O市",  
      "ad1bnc": "4-3-9",    
      "ad2tdfkcd": "23",    
      "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/

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
[usrList] 個人情報一覧 - - 登録数分、以下の情報を設定する。
-usrcd 氏名コード 半角英数字 32
-indpflg 所属有無 半角数字 1 0:所属あり/1:所属なし※省略時は「0:所属あり」
-orgpath 本務組織パス 半角英数字記号 331 ※所属有無が「0:所属あり」の場合、必須
-accflg 本務アクセス権限 半角英数字 1 アクセス権限フラグの値を指定
-[addorgList] 兼務組織一覧 - - - 最大4件
--orgpath 兼務組織パス 半角英数字記号 331 ※兼務組織一覧が設定されている場合、必須
--accflg 兼務アクセス権限 半角英数字 1 アクセス権限フラグの値を指定 ※兼務組織一覧が設定されている場合、必須
-kanasei カナ姓 全角カタカナ 32
-kanamei カナ名 全角カタカナ 32
-staffsei 全半角 32
-staffmei 全半角 32
-langcd 言語コード 半角英数字 2 'ja':日本語/'en':英語
-ctmcd ユーザ設定コード 半角英数字 32
-wktdfkcd 勤務先住所都道府県コード 半角数字 2 都道府県コードを指定
-wkskcs 勤務先住所市区町村 全半角 40
-wkaddbnc 勤務先住所番地 全半角 80
-lcncd ロケーションコード 半角英数字 32
-lcnnm ロケーション名称 全半角 40
-ad1tdfkcd 住所1都道府県コード 半角数字 2 都道府県コードを指定
-ad1skcs 住所1市区町村 全半角 40
-ad1bnc 住所1番地 全半角 80
-ad2tdfkcd 住所2都道府県コード 半角数字 2 都道府県コードを指定
-ad2skcs 住所2市区町村 全半角 40
-ad2bnc 住所2番地 全半角 80
-mail1 連絡先MAIL1 メール形式 100
-mail2 連絡先MAIL2 メール形式 100
-mail3 連絡先MAIL3 メール形式 100
-mailodr 連絡先MAIL順序 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-tel1 連絡先TEL1 半角数字 15
-tel1odr 連絡先TEL順序1 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-tel2 連絡先TEL2 半角数字 15
-tel2odr 連絡先TEL順序2 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-tel3 連絡先TEL3 半角数字 15
-tel3odr 連絡先TEL順序3 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-rsvtel 予備TEL 半角数字 15
-rsvmail 予備MAIL メール形式 100
-priority 送信優先順位 半角数字 1 1:高い~5:普通~9:低い
-certify 音声認証用個人ID 半角数字 32 利用可能デバイスが'0'(連絡先(MAIL)+連絡先(TEL))の場合、必須
-password 音声認証用パスワード 半角数字 8 利用可能デバイスが'0'(連絡先(MAIL)+連絡先(TEL))の場合、必須
-bscpassword Web認証用パスワード 半角英数字 32
-kojinmtdispflg 個人メンテナンス非表示使用フラグ 半角数字 1 0:未使用/1:使用

※1 MAIL、TELの順序が指定されない場合、デフォルト順序は1:MAIL、2:TEL1、3:TEL2、4: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",
            "wkskcs": "Y市",
            "wkaddbnc": "O区",
            "ad1tdfkcd": "01",
            "ad1skcs": "O市",
            "ad1bnc": "Y区",
            "ad2tdfkcd": "01",
            "ad2skcs": "O市",
            "ad2bnc": "C区",
            "mail1": "anpi-anpi@intas-anpi.com",
            "mailodr": 1,
            "priority": 5,
            "bscpassword": "pwd50000",
            "kojinmtdispflg": 0
        }
    ]
}

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(更新)

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

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
[usrList] 個人情報一覧 - - 更新数分、以下の情報を設定する。
-usrcd 氏名コード 半角英数字 32
-indpflg 所属有無 半角数字 1 0:所属あり/1:所属なし※省略時は「0:所属あり」
-orgpath 本務組織パス 半角英数字記号 331
-accflg 本務アクセス権限 半角英数字 1 アクセス権限フラグの値を指定 ※本務組織パスが指定されている場合または、所属有無が「1:所属あり」の場合、必須
-[addorgList] 兼務組織一覧 - - - 最大4件 ※兼務組織一覧を更新しない場合は、兼務組織一覧をリクエストに指定しない。全兼務組織を削除する場合は、兼務リストを「NULL」または空で指定する。一部の兼務組織を削除する場合は、削除したい組織情報を抜いた組織リストを指定する
--orgpath 兼務組織パス 半角英数字記号 331 ※兼務組織一覧が設定されている場合、必須
--accflg 兼務アクセス権限 半角英数字 1 アクセス権限フラグの値を指定 ※兼務組織一覧が設定されている場合、必須
-kanasei カナ姓 全角カタカナ 32
-kanamei カナ名 全角カタカナ 32
-staffsei 全半角 32
-staffmei 全半角 32
-langcd 言語コード 半角英数字 2 'ja':日本語/'en':英語
-ctmcd ユーザ設定コード 半角英数字 32
-wktdfkcd 勤務先住所都道府県コード 半角数字 2 都道府県コードを指定
-wkskcs 勤務先住所市区町村 全半角 40
-wkaddbnc 勤務先住所番地 全半角 80
-lcncd ロケーションコード 半角英数字 32
-ad1tdfkcd 住所1都道府県コード 半角数字 2 都道府県コードを指定
-ad1skcs 住所1市区町村 全半角 40
-ad1bnc 住所1番地 全半角 80
-ad2tdfkcd 住所2都道府県コード 半角数字 2 都道府県コードを指定
-ad2skcs 住所2市区町村 全半角 40
-ad2bnc 住所2番地 全半角 80
-mail1 連絡先MAIL1 メール形式 100
-mail2 連絡先MAIL2 メール形式 100
-mail3 連絡先MAIL3 メール形式 100
-mailodr 連絡先MAIL順序 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-tel1 連絡先TEL1 半角数字 15
-tel1odr 連絡先TEL順序1 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-tel2 連絡先TEL2 半角数字 15
-tel2odr 連絡先TEL順序2 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-tel3 連絡先TEL3 半角数字 15
-tel3odr 連絡先TEL順序3 半角数字 1 ※1 1~4の値を設定(1:最初 4:最後)連絡先TEL順序1~連絡先TEL順序4、連絡先MAIL順序で重複しない値
-rsvtel 予備TEL 半角数字 15
-rsvmail 予備MAIL メール形式 100
-priority 送信優先順位 半角数字 1 1:高い~5:普通~9:低い
-certify 音声認証用個人ID 半角数字 32 利用可能デバイスが'0'(連絡先(MAIL)+連絡先(TEL))の場合、必須
-password 音声認証用パスワード 半角数字 8 利用可能デバイスが'0'(連絡先(MAIL)+連絡先(TEL))の場合、必須
-bscpassword Web認証用パスワード 半角英数字 32
-kojinmtdispflg 個人メンテナンス非表示使用フラグ 半角数字 1 0:未使用/1:使用

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",
            "wkskcs": "O市",
            "wkaddbnc": "P区",
            "ad1tdfkcd": "01",
            "ad1skcs": "P市",
            "ad1bnc": "I区",
            "ad2tdfkcd": "01",
            "ad2skcs": "RR市",
            "ad2bnc": "P区",
            "mail1": "anpi-anpi@intas-anpi.com",
            "mailodr": 1,
            "priority": 5,
            "bscpassword": "pwd50000",
            "kojinmtdispflg": 0
        }
    ]
}

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/user/

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
[usrList] 個人情報一覧 - - 配列
-usrcd 氏名コード 半角英数字 32 削除数分設定する。

Example Request

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

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
}

戻る