階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 省略可否 補足説明・備考等
1 contracts 契約回線番号 必須
1-1 {contractId} ・N番 必須
2 authentications 認証ログ一覧 必須
3 startTime 開始日時(検索対象開始日時) 必須
3-1 {startTime} ・開始日時(検索対象開始日時) 必須
4 endTime 終了日時(検索対象開始日時) 必須
4-1 {endTime} ・終了日時(検索対象開始日時) 必須
5 lineNoSearchKey 回線番号検索キー 必須 forBizは認証ID検索は行わず、回線番号
検索のみとする
5-1 {lineNoSearchKey} ・回線番号検索キー 必須
GET /v1/bocnmf/contracts/{contractId}/authentications?startTime={startTime}&endTime=
{endTime} & lineNoSearchKey = {lineNoSearchKey}
2-2.情報表示API
2-2.情報表示
2-2-4.認証ログ一覧[authentications] （2/4）
・回線の認証ログを表示するAPI
（１）APIのサンプル構文（API個別部）
＊リクエスト例
＊
JSON形式によるリクエスト例
＊レスポンス(1/1)
階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 省略可否 補足説明・備考等
1 contractId 契約番号(N番) 必須
2 searchList[] 結果リスト[] 必須
2-1 lineNo 回線番号 必須
2-2 sessionType 国内 必須
2-3 sessionTime 認証時間(認証時刻) 必須
2-4 authenticationResult ログ内容(認証結果) 必須
無し
GET /v1/bocnmf/contracts/N123456789/authentication?startTime=20200101131313
&endTime=202001011313138&lineNoSearchKey=09012345678
2-2.情報表示API
2-2.情報表示
2-2-4.認証ログ一覧[authentications] （3/4）
・回線の認証ログを表示するAPI 。
＊レスポンス例
{ "contractId": "N123456789",
"searchList " : [
{ "lineNo": "09012345678",
"sessionType" : "0",
"sessionTime": " 20200101131313 ",
"authenticationResult": "01"
},{
検索結果数分繰り返し ] }
}
2-2.情報表示API
ユーザー API-GW 備考
認証ログ確認
（リクエスト）
契約者番号 (N番)確認
OK NG(エラー④(※))
O Auth2 OK
認証ログ情報取得
（レスポンス）
レスポンスエラー
レスポンスエラー NG(エラー①②③⑳(※))
【API項目(インプット)】
・契約番号(N番) ・回線番号
入力値チェック
NG(エラー⑮ ⑯(※)) レスポンスエラー
回線情報一覧取得
（リクエスト）
回線番号認証
認証履歴検索照会
（リクエスト）
レスポンスエラー
NG(エラー⑤(※))
OK
2-2.情報表示
2-2-4.認証ログ一覧[authentications] （4/4）
・回線の認証ログを表示するAPI。
（２）APIの動作フロー
回線情報一覧取得APIのレ スポンス結果内に、ユー ザーが指定した回線番号が あるかをチェックします。
API取得データ
OK
2-2.情報表示API
2-2.情報表示
2-2-5.接続ログ一覧[sessions] （1/4）
・回線の接続ログを表示するAPI
（１）APIのサンプル構文（API個別部）
＊リクエスト構文
＊構文説明
＊引数 （緑色の行に必要な値を投入して、構文を生成すること。投入時、波カッコ{}は、不要)
＊
BODY部に渡すJSON形式の引数 (1/1)
回線毎の接続ログを取得する。 ※検索結果は1000件まで表示。
階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 省略可否 補足説明・備考等
1 contracts 契約回線番号 必須
1-1 {contractId} ・N番 必須
2 sessions 接続ログ一覧 必須
3 startTime 開始日時(検索対象開始日時) 必須
3-1 {startTime} ・開始日時(検索対象開始日時) 必須
4 endTime 終了日時(検索対象開始日時) 必須
4-1 {endTime} ・終了日時(検索対象開始日時) 必須
5 lineNoSearchKey 回線番号検索キー 必須 forBizは認証ID検索は行わず、回線番号
検索のみとする
5-1 {lineNoSearchKey} ・回線番号検索キー 必須
GET /v1/bocnmf/contracts/{contractId}/sessions?startTime={startTime}&endTime=
{endTime} & lineNoSearchKey = {lineNoSearchKey}
2-2.情報表示API
2-2.情報表示
2-2-5.接続ログ一覧[sessions] （2/4）
・回線の接続ログを表示するAPI
（１）APIのサンプル構文（API個別部）
＊リクエスト例
＊
JSON形式によるリクエスト例
＊レスポンス(1/1)
階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 省略可否 補足説明・備考等
1 contractId 契約番号 必須
2 searchList[] 結果リスト[] 必須
2-1 lineNo 回線番号 必須
2-2 sessionType 国内 必須
2-3 sessionTime 接続開始時間 必須
2-4 eventType イベント種別 必須
無し
GET /v1/bocnmf/contracts/N123456789/sessions?startTime=20200101131313
&endTime=20200101131313&lineNoSearchKey=09012345678
2-2.情報表示API
2-2.情報表示
2-2-5.接続ログ一覧[sessions] （3/4）
・回線の接続ログを表示するAPI
＊レスポンス例
{ "contractId": "N123456789",
"searchList": [
{ "lineNo": "09012345678",
"sessionType": "1",
"sessionTime": " 20200101131313 ",
"eventType ": "01"
},{
検索結果数分繰り返し ] }
}
2-2.情報表示API
ユーザー API-GW 備考
認証ログ確認
（リクエスト）
契約者番号 (N番)確認
OK NG(エラー④(※))
O Auth2 OK
認証ログ情報取得
（レスポンス）
レスポンスエラー
レスポンスエラー NG(エラー①②③⑳(※))
【API項目(インプット)】
・契約番号(N番) ・回線番号
入力値チェック
NG(エラー⑮ ⑯(※)) レスポンスエラー
回線情報一覧取得
（リクエスト）
回線番号認証
認証履歴検索照会
（リクエスト）
レスポンスエラー
NG(エラー⑤(※))
OK
2-2.情報表示
2-2-5.接続ログ一覧[sessions] （4/4）
・回線の接続ログを表示するAPI
（２）APIの動作フロー
回線情報一覧取得APIのレ スポンス結果内に、ユー ザーが指定した回線番号が あるかをチェックします。
API取得データ
OK
2-2.情報表示API
2-2.情報表示
2-2-9.容量シェア運用情報表示 [dataShare-traffic]（1/6)
・契約N番配下の容量シェア運用情報を参照するAPI
（１）APIのサンプル構文（API個別部）
＊リクエスト構文
＊説明
＊引数 （緑色の行に必要な値を投入して、構文を生成すること。投入時、波カッコ{}は、不要)
＊
BODY部に渡すJSON形式の引数 (1/1)
＊リクエスト例