Documentation Powered by ReDoc

ギャランティリソースAPI (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

本APIでは、docomo business RINKのギャランティ接続のリソース情報の参照・操作が可能です。

docomo business RINK ギャランティ接続のお申し込みの全体の流れは以下

  • IWアクセス回線の住所照会(住所コードの取得)
  • 住所照会で取得したコードを元にIWアクセス回線の提供可否を判定
  • IWアクセス回線の稼働日照会（現地調査、宅内工事の空き日時の取得）
  • ギャランティ接続リソース作成&IWアクセス回線の現地調査、宅内工事の予約
    • IWアクセス回線の場合は、現地調査、宅内工事の予約を行った時点で申し込みになる
    • 現調のみOKだった場合は、オーダ変更申し込みで確定した現調情報とともにたく宅内工事の申し込みを行う
    • 稼働日予約の結果はこちらからGETしないとわからない
  • ギャランティ接続の回線ごとのパラメータ設定は端末申込(Terminal API)で実施する
    • L2はギャランティ接続リソース、L3はルーターリソースとして持つ

guarantees

ギャランティ一覧取得API

  • ギャランティ接続リソースを一覧取得するAPI
  • ギャランティ接続の情報としてパターン別に取得できる情報の詳細はギャランティ回線情報取得APIを参照
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=5

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
integer >= 0 characters >= 0
Default: 0
Example: offset=5

表示するページ番号の指定（デフォルト0）

guaranteeId
string ^Z[0-9]{9}$
Example: guaranteeId=Z123456789

ギャランティ接続リソースのID. 指定なしならテナント内のすべての ギャランティ接続リソースが検索対象

customerNote
string

customerNoteの部分一致検索

sortKey
string

ソート項目の指定. レスポンスボディの項目から

direction
string
Enum: "asc" "desc"

ソート順の指定. asc: 昇順, desc: 降順

resourceStatus
string
Enum: "inactive" "active" "terminated"

リソースステータス

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/guarantees
http://api.ntt.com/ztgict/v1/guarantees

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "guarantees":
    [
    ]
}

ギャランティ申込API

  • ギャランティ接続リソースの新規作成API
  • IWアクセス回線の現地調査・宅内工事稼働日予約も同時に行う
  • 開通希望日は宅内工事日以降の日付を指定（宅内工事日を含む）
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
customerNote
string <= 64 characters

回線名 (全角・半角・記号許容)

userInterfaceType
string
Enum: "100BASE-TX" "1000BASE-LX" "1000BASE-SX" "1000BASE-T"

ギャランティ接続で契約しているIWアクセス回線のユーザー網インターフェース

  • physicalBandwidth:100Mの場合
    • 100BASE-TX
  • physicalBandwidth:1Gの場合
    • 1000BASE-LX
    • 1000BASE-SX
    • 1000BASE-T
physicalBandwidth
string
Enum: "100M" "1G"

ギャランティ接続で契約している物理帯域

  • 100M: 物理帯域100Mbps
  • 1G: 物理帯域1Gbps
internet
object

ギャランティ接続で契約しているインターネットの情報

vpn
object

ギャランティ接続で契約しているVPN接続の情報

installationPlaceCode
string ^[a-f0-9]{32}$

設置場所を示すコード、UUID形式 住所照会APIの結果として返却される収容区域コードと設置住所情報を紐づけたもの

constructionType
string
Enum: "toMDFtag" "toMDFjumper" "toIDFtag" "toTerminal"

工事区分

  • ToMDFtag: MDF荷札
  • ToMDFjumper: MDFジャンパ
  • ToIDFtag: IDF荷札
  • ToTerminal: 端末直前まで
wiringType
string
Enum: "rental" "selfDevice"

配線区分

  • rental: レンタル
  • selfDevice: お客様装置
communicationMode
string
Enum: "full-duplex" "auto-nego"

通信モード

  • full-duplex: 全二重通信固定
  • auto-nego: オートネゴシエーション userInterfaceType が 100BASE-TX の場合は "full-duplex" のみ選択可能 userInterfaceType が 1000BASE-TX の場合は "auto-nego" のみ選択可能 userInterfaceType が 1000BASE-SX, 1000BASE-LX の場合は "full-duplex", "auto-nego" が選択可能
fieldSurveyLess
boolean
Default: false

現調レスを希望する項目

  • false：現地調査ありで申し込み
  • true：現地調査レスで申し込み
fieldSurvey
object

IWアクセス回線取得のデータ内の新設現地調査日の予約リクエスト内容

construction
object

IWアクセス回線取得のデータ内の新設宅内工事日の予約リクエスト内容

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/guarantees
http://api.ntt.com/ztgict/v1/guarantees

Request samples

Content type
application/json
Example
ギャランティ申込API(IWAN現地調査あり申請)
Copy
 Expand all Collapse all
{
  • "customerNote": "東ギャラ",
  • "userInterfaceType": "100BASE-TX",
  • "physicalBandwidth": "100M",
  • "internet":
    {
    },
  • "vpn":
    {
    },
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
  • "constructionType": "toMDFtag",
  • "wiringType": "rental",
  • "communicationMode": "full-duplex",
  • "fieldSurveyLess": false,
  • "fieldSurvey":
    {
    },
  • "construction":
    {
    }
}

Response samples

Content type
application/json
Example
ギャランティ申込API(IWAN現地調査あり申請)
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "inactive",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "guaranteeId": "Z123456789",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "ref": "/v1/guarantees/Z123456789",
  • "customerNote": "東ギャラ",
  • "userInterfaceType": "100BASE-TX",
  • "physicalBandwidth": "100M",
  • "internet":
    {
    },
  • "vpn":
    {
    },
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
  • "constructionType": "toMDFtag",
  • "wiringType": "rental",
  • "communicationMode": "full-duplex",
  • "fieldSurveyLess": false,
  • "fieldSurvey":
    {
    },
  • "construction":
    {
    }
}

ギャランティ回線情報取得API

  • ギャランティ接続リソースを取得するAPI
  • ギャランティ接続としての情報とそれに紐づいたIWアクセス回線の情報を取得
path Parameters
guaranteeId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/guarantees/{guaranteeId}
http://api.ntt.com/ztgict/v1/guarantees/{guaranteeId}

Response samples

Content type
application/json
Example
ギャランティ回線情報取得（現調・新設宅内工事稼働日未確定）
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "inactive",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartTime": "2019-05-21T10:05:48+09:00",
  • "guaranteeId": "Z123456789",
  • "accessLineId": "123456789",
  • "ref": "/v1/guarantees/Z123456789",
  • "customerNote": "東ギャラ",
  • "userInterfaceType": "100BASE-TX",
  • "physicalBandwidth": "100M",
  • "internet":
    {
    },
  • "vpn":
    {
    },
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
  • "constructionType": "toMDFtag",
  • "wiringType": "rental",
  • "communicationMode": "full-duplex",
  • "fieldSurveyLess": false,
  • "fieldSurvey":
    {
    },
  • "construction":
    {
    }
}

ギャランティ変更API

  • ギャランティ接続リソースを変更するAPI
  • 変更したい項目のみボディに記載しリクエストする
  • 既存の設定を削除したい場合はnullを設定する
  • IWアクセス回線の物理回線の変更は廃止・新設で行うため、ギャランティの変更APIでは変更不可
  • IWアクセス回線の稼働日予約に関するオーダの修正はOrder APIで行う
    • OrderのPUTで変更した場合に、SDPの内部処理によってギャランティ接続のリソースに反映される
path Parameters
guaranteeId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
customerNote
string <= 64 characters

回線名 (全角・半角・記号許容)

internet
object

ギャランティ接続で契約しているインターネットの情報

vpn
object

ギャランティ接続で契約しているVPN接続の情報

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/guarantees/{guaranteeId}
http://api.ntt.com/ztgict/v1/guarantees/{guaranteeId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "東ギャラ",
  • "internet":
    {
    },
  • "vpn":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "active",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartTime": "2019-05-21T10:05:48+09:00",
  • "guaranteeId": "Z123456789",
  • "accessLineId": "123456789",
  • "ref": "/v1/guarantees/Z123456789",
  • "customerNote": "東ギャラ",
  • "physicalBandwidth": "100M",
  • "terminalId": "Z000000001",
  • "internet":
    {
    },
  • "vpn":
    {
    },
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
  • "fieldSurveyLess": false,
  • "constructionType": "toMDFtag",
  • "wiringType": "rental",
  • "communicationMode": "full-duplex",
  • "fieldSurvey":
    {
    },
  • "construction":
    {
    }
}

ギャランティリソース削除API

  • ギャランティ接続リソースの削除API
  • IWアクセス回線の廃止稼働日予約も同時に行う
path Parameters
guaranteeId
required
string
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
removal
required
object

IWアクセス回線取得のデータ内の新設宅内工事日の予約リクエスト内容

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/guarantees/{guaranteeId}
http://api.ntt.com/ztgict/v1/guarantees/{guaranteeId}

Request samples

Content type
application/json
Example
ギャランティリソース削除(IWAN廃止)
Copy
 Expand all Collapse all
{
  • "removal":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceStatus": "active",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartTime": "2019-05-21T10:05:48+09:00",
  • "guaranteeId": "Z123456789",
  • "accessLineId": "123456789",
  • "ref": "/v1/guarantees/Z123456789",
  • "customerNote": "東ギャラ",
  • "physicalBandwidth": "100M",
  • "internet":
    {
    },
  • "vpn":
    {
    },
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
  • "fieldSurveyLess": false,
  • "removal":
    {
    }
}

提供判定

  • IWアクセス回線の提供可否を判断するAPI
  • 光コラボでは品目ごとの判定を行っているが、作成時点では100Mのみの提供なので、品目ごとの判定は行わない
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
installationPlaceCode
required
string ^[a-f0-9]{32}$

設置場所を示すコード、UUID形式 住所照会APIの結果として返却される収容区域コードと設置住所情報を紐づけたもの

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/iwan-util/judge
http://api.ntt.com/ztgict/v1/iwan-util/judge

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6"
}

Response samples

Content type
application/json
Example
IWAN提供可
Copy
 Expand all Collapse all
{
  • "installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
  • "serviceAvailable": true
}

住所登録依頼API

ギャランティ接続の住所登録を申し込むAPI

  • 本APIの利用前に住所照会APIへのコールが必要となる。
  • 本APIのリクエストキーのpostalCode,prefecture,municipality,largerSection,sectionは住所照会APIのレスポンスを設定する。レスポンスがリストの場合はその中から1つ選択し設定する。
  • 本APIのリクエストキーのhouseNumber1,houseNumber2,houseNumber3,buildingName1,buildingName2,buildingName3は自由入力が可能。全角で入力すること。
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
postalCode
required
string ^[0-9]{3}-[0-9]{4}$

ご利用場所郵便番号。ハイフンあり

prefecture
required
string [ 1 .. 4 ] characters
  • 都道府県
municipality
required
string [ 1 .. 12 ] characters
  • 市区郡町村
largerSection
string [ 1 .. 18 ] characters
  • 大字・通称
section
string [ 1 .. 12 ] characters
  • 字・丁目
houseNumber1
string [ 1 .. 20 ] characters
  • 番地号１
  • houseNumber2に設定がある場合は必須
houseNumber2
string [ 1 .. 10 ] characters
  • 番地号２
  • houseNumber3に設定がある場合は必須
houseNumber3
string [ 1 .. 10 ] characters
  • 番地号３
buildingName1
string [ 1 .. 20 ] characters
  • 建物名１
  • buildingName2に設定がある場合は必須
buildingName2
string [ 1 .. 10 ] characters
  • 建物名２
  • buildingName3に設定がある場合は必須
  • 地下の表記はＢxx階ではなく地下xx階とする
  • 階数の表記はxxＦではなくxx階とする
buildingName3
string [ 1 .. 10 ] characters
  • 建物名３
  • 部屋号の表記はxx号室ではなくxx号とする
latitude
required
string 9 characters

座標情報（緯度）

longitude
required
string 10 characters

座標情報（経度）

mapDocumentId
required
string ^[0-9a-f]{32}$

地図情報ファイル。確認書類アップロードAPI callにより返却されたdocumentId

companyName
required
string [ 1 .. 190 ] characters

設置住所登録依頼申込者の事業所名

personName
required
string [ 1 .. 40 ] characters

設置住所登録依頼申込者の担当者氏名

phoneNumber
required
string <= 13 characters ^0

設置住所登録依頼申込者の担当者電話番号。ハイフン必須

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/iwan-util/registration-address
http://api.ntt.com/ztgict/v1/iwan-util/registration-address

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "postalCode": "160-0023",
  • "prefecture": "東京都",
  • "municipality": "新宿区",
  • "largerSection": "西新宿",
  • "section": "３丁目",
  • "houseNumber1": "１９",
  • "houseNumber2": "２",
  • "houseNumber3": "５",
  • "buildingName1": "山田ビル１",
  • "buildingName2": "２階",
  • "buildingName3": "２０２号",
  • "latitude": "35.687046",
  • "longitude": "139.767876",
  • "mapDocumentId": "550e8400e29b41d4a716446655440000",
  • "companyName": "ＮＴＴコミュニケーションズ",
  • "personName": "山田　太郎",
  • "phoneNumber": "03-1234-5678"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "postalCode": "160-0023",
  • "prefecture": "東京都",
  • "municipality": "新宿区",
  • "largerSection": "西新宿",
  • "section": "３丁目",
  • "houseNumber1": "１９",
  • "houseNumber2": "２",
  • "houseNumber3": "５",
  • "buildingName1": "山田ビル１",
  • "buildingName2": "２階",
  • "buildingName3": "２０２号",
  • "latitude": "35.687046",
  • "longitude": "139.767876",
  • "mapDocumentId": "550e8400e29b41d4a716446655440000",
  • "companyName": "ＮＴＴコミュニケーションズ",
  • "personName": "山田　太郎",
  • "phoneNumber": "03-1234-5678"
}