ユーザ設定コード情報API

Overview

本APIはユーザ設定コード、ユーザ設定コード名などのユーザ設定コードに紐づく情報を閲覧/登録/変更/削除することができます。

-ユーザ設定コード情報API(情報照会)
-ユーザ設定コード情報API(登録)
-ユーザ設定コード情報API(更新)
-ユーザ設定コード情報API(削除)

 ユーザ設定コード情報API

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

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

Request Parameters

URL Path Parameter

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

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

Example Request

GET https://api.ntt.com/v1/anpi/maintenance/user-setting-code/?ctmcd=xxxxx&limit=10

Response Parameters

正常時

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

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
[ctmList] ユーザ設定コード情報一覧 - - - 検索結果数分、以下の情報を設定する。
-ctmcd ユーザ設定コード 半角英数字 32
-ctmnm ユーザ設定コード名称 全半角 40

異常時

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

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

Example Result

{   
  "searchTotal": 2000,  
  "searchCount": 10,    
  "nextOffset": 10, 
  "useCount": 4365762,  
  "contractCount": -1,  
  "ctmList": [  
    {   
      "ctmcd": 0001,    
      "ctmnm": "1stユーザ設定コード"
    }   
 ]  
}

戻る

 ユーザ設定コード情報API(登録)

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

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
[ctmList] ユーザ設定コード情報一覧 - - 登録数分、以下の情報を設定する。
-ctmcd ユーザ設定コード 半角英数字 32
-ctmnm ユーザ設定コード名称 全半角 40

Example Request

POST https://api.ntt.com/v1/anpi/maintenance/user-setting-code/
{
    "ctmList": [
        {
            "ctmcd": 0001,
            "ctmnm": "ユーザ設定コードA"
        }
    ]
}

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-setting-code/

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
[ctmList] ユーザ設定コード情報一覧 - - 更新数分、以下の情報を設定する。
-ctmcd ユーザ設定コード 半角英数字 32
-ctmnm ユーザ設定コード名称 全半角 40

Example Request

PUT https://api.ntt.com/v1/anpi/maintenance/user-setting-code/
{
    "ctmList": [
        {
            "ctmcd": 0001,
            "ctmnm": "ユーザ設定コードA"
        }
    ]
}

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-setting-code/

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
[ctmcdList] ユーザ設定コード一覧 - - 配列
ユーザ設定コード 半角英数字 32 削除数分設定する。

Example Request

DELETE https://api.ntt.com/v1/anpi/maintenance/user-setting-code/
{
    "ctmcdList": [
        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
}

戻る