組織情報API

Overview

本APIは組織コード、組織名、組織階層などの組織に紐づく情報を閲覧/登録/変更/削除することができます。
-組織情報API（情報照会）
-組織情報API（登録）
-組織情報API（更新）
-組織情報API（削除）

　組織情報API（情報照会）

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

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

Request Parameters

URL Path Parameter

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

項目 名称 型 桁数 必須 備考
orghr 組織階層 半角数字 2 絞り込み条件（完全一致）
orgcd 組織コード 半角英数字 32 絞り込み条件（前方一致）
orgnm 組織名 全半角 60 絞り込み条件（部分一致）
orgpath 基点組織 半角英数字記号 331 絞り込み条件（前方一致）、入力された場合は他の絞り込み条件を無視する
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

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

Response Parameters

正常時

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

項目 名称 型 桁数 必須 備考
searchTotal 検索総件数 半角数字 6 ◎
searchCount 検索件数 半角数字 4 ◎
nextOffset 次回検索開始位置 半角数字 6 ◎
useCount 利用回数 半角数字 8 ◎
contractCount 契約回数 半角数字 8 ◎
[orgList] 組織情報一覧 - - - 検索結果数分、以下の情報を設定する
-orgcd 組織コード 半角英数字 32
-orgpath 組織パス 半角英数字記号 331
-orgpathnm 組織パス名称 全半角 627

異常時

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

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

Example Result

{   
  "searchTotal": 200000,    
  "searchCount": 10,    
  "nextOffset": 10, 
  "useCount": 4365762,  
  "contractCount": -1,  
  "orgList": [  
    {   
      "orgcd": "0001",  
      "orgpath": "/1stAAAA00001/",  
      "orgpathnm": "1st組織00001"
    },  
     {  
      "orgcd": "0002",  
      "orgpath": "/1stAAAA00002/",  
      "orgpathnm": "1st組織00002"
    }
 ]  
}

戻る

　組織情報API（登録）

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

団体に組織情報を登録します。
一度に登録できる情報は最大12,000件までとなります。

Request Parameters

Body json Parameter

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

項目 名称 型 桁数 必須 備考
[orgList] 組織情報一覧 - - ◎ 登録数分、以下の情報を設定する。
-orgpath 組織パス 半角英数字記号 331 ◎
-orgnm 組織名 全半角 60 ◎

Example Request

POST https://api.ntt.com/v1/anpi/maintenance/organization/
{
    "orgList": [
        {
            "orgpath": "/1stAAAA00001/",
            "orgnm": "組織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/organization/

団体の組織情報を更新します。
一度に更新できる情報は最大12,000件までとなります。

Request Parameters

Body json Parameter

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

項目 名称 型 桁数 必須 備考
[orgList] 組織情報一覧 - - ◎ 更新数分、以下の情報を設定する。
-orgpath 組織パス 半角英数字記号 331 ◎
-orgnm 組織名 全半角 60 ◎

Example Request

PUT https://api.ntt.com/v1/anpi/maintenance/organization/
{
    "orgList": [
        {
            "orgpath": "/1stAAAA00001/",
            "orgnm": "組織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/organization/

団体の組織情報を削除します。
一度に削除できる情報は最大12,000件までとなります。

Request Parameters

Body json Parameter

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

項目 名称 型 桁数 必須 備考
[orgpathList] 組織パス一覧 - - ◎ 配列
-orgpath 組織パス 半角英数字記号 331 ◎ 削除数分設定する。

Example Request

DELETE https://api.ntt.com/v1/anpi/maintenance/organization/
{
    "orgpathList": [
        "/APITEST1000/"
    ]
}

Response Parameters

正常時

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

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

異常時

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

Example Result

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

戻る