フレッツ回線API (1.0)

Download OpenAPI specification:Download

概要

本APIでは、docomo business RINKのベストエフォートIPoE接続情報の参照・操作が可能です。

fletsSeparate

フレッツ別契約回線新規作成API

IPoE 回線を新規作成する API

フレッツ回線ID/お客さまIDとアクセスキーがある場合、それ以外の情報は不要。
フレッツ回線ID/お客さまIDがありアクセスキーがない場合、契約者名義(漢字)、契約者名義(カナ)、契約者連絡先電話番号、契約者連絡先メールアドレス、申込者名(漢字)、申込者名(カナ)、申込者連絡先電話番号、申込者連絡先メールアドレス、ご利用場所電話番号のいずれか一つが必要。
フレッツ回線ID/お客さまIDもアクセスキーも無い場合、契約者名義(漢字)、契約者名義(カナ)・申込者名(漢字)、申込者名(カナ)のうちいずれか一つ、契約者郵便番号・ご利用場所郵便番号のうちいずれか一つ、契約者連絡先電話番号、申込者連絡際電話番号、ご利用場所電話番号、契約者連絡先メールアドレス、込者連絡先メールアドレスのうちいずれか一つがそれぞれ必要。

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

customerNote required	string 回線名 (全角・半角・記号許容)
fletsId	string CAF、COP番号。 CAF数字10桁、COP数字8桁
ipoeType required	string Default: "normal" Enum: "normal" "wide" ベストエフォートIPoE接続 normal: 標準 wide: ワイド
appControl required	boolean Default: false ワイドプラス for Web会議の利用有無。ベストエフォートIPoE接続のプランがワイドの場合のみ利用可。
accessKey	string アクセスキー. CAF, COP番号と同様にNTT東⽇本・⻄⽇本から払い出されるキー情報. 英数字8桁
fletsOpen required	boolean Default: true フレッツが開通しているか未開通か true: 開通済み false: 未開通
fletsOpenDate	string <date> フレッツ回線が未開通の場合、フレッツ回線の開通日を記載 fletsOpenがfalseの場合、必須
ipoeApplicationDate	string <date> 開通希望日。指定した日に開通処理を開始する。指定無しの場合即時開通処理を開始する。当日または過去日を指定した場合エラーとなる。
applicant	object 申込者情報
originContractor	object 契約者情報
installationPlace	object 設置場所情報

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/ipoe/separate-contract

https://api.ntt.com/sdpf-ztgict/v1/ipoe/separate-contract

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"customerNote": "IPoE回線1",
"fletsId": "CAF0123456789",
"fletsOpen": true,
"ipoeType": "normal",
"ipoeApplicationDate": "2022-02-02",
"appControl": false,
"accessKey": "1a2b3c4D"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"tenantId": "550e8400e29b41d4a716446655440000",
"resourceStatus": "inactive",
"orderId": "550e8400e29b41d4a716446655440000",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"customerNote": "IPoE回線1",
"fletsId": "CAF0123456789",
"fletsOpen": true,
"ipoeType": "normal",
"appControl": false,
"accessKey": "1a2b3c4D"
}

フレッツ別契約回線取得API

ベストエフォートIPoE接続(フレッツ別契約型)のフレッツ回線を取得する API

path Parameters

ipoeId

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/ipoe/separate-contract/{ipoeId}

https://api.ntt.com/sdpf-ztgict/v1/ipoe/separate-contract/{ipoeId}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"ref": "/v1/ipoe/separate-contract/Z123456789",
"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",
"customerNote": "IPoE回線1",
"fletsId": "CAF0123456789",
"ipoeType": "wide",
"appControl": true,
"accessKey": "1a2b3c4D",
"fletsOpen": true
}

フレッツ別契約回線更新API

ベストエフォートIPoE接続(フレッツ別契約型)のフレッツ回線を更新する API

path Parameters

ipoeId

required

string

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

customerNote	string
ipoeType	string Enum: "normal" "wide" ベストエフォートIPoE接続 normal: 標準 wide: ワイド
appControl	boolean ワイドプラス for Web会議の利用有無。ベストエフォートIPoE接続のプランがワイドの場合のみ利用可。

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/ipoe/separate-contract/{ipoeId}

https://api.ntt.com/sdpf-ztgict/v1/ipoe/separate-contract/{ipoeId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customerNote": "IPoE回線1",
"ipoeType": "normal",
"appControl": false
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"ref": "/v1/ipoe/separate-contract/Z123456789",
"terminalId": "Z123456789",
"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",
"customerNote": "IPoE回線1",
"fletsId": "CAF0123456789",
"ipoeType": "normal",
"appControl": false,
"accessKey": "1a2b3c4D",
"fletsOpen": true
}

フレッツ別契約回線廃止API

ベストエフォートIPoE接続(フレッツ別契約型)のフレッツ回線を廃止する API

path Parameters

ipoeId

required

string

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/ipoe/separate-contract/{ipoeId}

https://api.ntt.com/sdpf-ztgict/v1/ipoe/separate-contract/{ipoeId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"ref": "/v1/ipoe/separate-contract/Z123456789",
"terminalId": "Z123456789",
"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",
"customerNote": "IPoE回線1",
"fletsId": "CAF0123456789",
"ipoeType": "normal",
"appControl": true,
"accessKey": "1a2b3c4D",
"fletsOpen": false,
"fletsOpenDate": "2022-02-02",
"applicant": 
{"name": "山田　太郎",
"nameKana": "ヤマダ　タロウ",
"phoneNumber": "03-1234-5678",
"mailAddress": "example@example.com"
},
"originContractor": 
{"name": "山田　太郎",
"nameKana": "ヤマダ　タロウ",
"phoneNumber": "03-1234-5678",
"postalCode": "000-0000",
"mailAddress": "example@example.com"
},
"installationPlace": 
{"postalCode": "000-0000",
"phoneNumber": "00-0000-0000"
}
}

hikariCollabo

光コラボ回線新規作成API

ベストエフォートIPoE接続(光一括提供型)の光回線を新規作成する API

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

customerNote required	string 回線名 (全角・半角・記号許容)
fletsOrderType required	string Value: "new" オーダー種別 new: コラボ光新設
fletsType	string Enum: "family200M" "family1G" "mansion200M" "mansion1G" ベストエフォートIPoE接続の品目、新規申し込みのとき必須 family200M：ファミリー200M family1G：ファミリー1G mansion200M：マンション200M mansion1G：マンション1G
ipoeType required	string Default: "normal" Enum: "normal" "wide" ベストエフォートIPoE接続 normal: 標準 wide: ワイド
appControl required	boolean Default: false ワイドプラス for Web会議の利用有無。ベストエフォートIPoE接続のプランがワイドの場合のみ利用可。
installationPlaceCode	string ^[a-f0-9]{32}$ 住所コード、uuid形式。住所検索APIで返却された「住所コード」を設定。 fletsOrderTypeがnewの場合に必須
fletsId	string CAF、COP番号。 CAF数字10桁、COP数字8桁
onSiteRepairOption required	boolean Default: false 光回線24時間出張修理オプション fletsOrderTypeがnewのとき指定可能 trueにした場合、開通月は変更不可 true: 有 false: 無
constructionOption	object 工事オプション情報 fletsOrderTypeがnewの場合必須工事オプションを利用の場合は、以後チケット発行が必要

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/ipoe/hikari-collabo

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customerNote": "光コラボ回線1",
"fletsOrderType": "new",
"fletsType": "family200M",
"ipoeType": "normal",
"appControl": false,
"installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
"onSiteRepairOption": true,
"constructionOption": 
{"siteRouteSurvey": true,
"lineConfirmation": true,
"wiringRouteConstruction": true,
"constructionResultReport": true,
"photographConsent": true,
"photographConsentName": "山田　太郎",
"specifiedVisitDateTime": true
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"customerNote": "光コラボ回線1",
"postalCode": "100-0000",
"address": "東京都港区港南１丁目９−１",
"ref": "/v1/ipoe/hikari-collabo/Z123456789",
"fieldSurveyRequirement": true,
"ticketIssueRequirement": false,
"tenantId": "550e8400e29b41d4a716446655440000",
"resourceStatus": "inactive",
"orderId": "550e8400e29b41d4a716446655440000",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"fletsOrderType": "new",
"fletsType": "family200M",
"ipoeType": "normal",
"appControl": false,
"installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
"onSiteRepairOption": true,
"constructionOption": 
{"siteRouteSurvey": true,
"lineConfirmation": true,
"wiringRouteConstruction": true,
"constructionResultReport": true,
"photographConsent": true,
"photographConsentName": "山田　太郎",
"specifiedVisitDateTime": true
}
}

光コラボ回線取得API

ベストエフォートIPoE接続(光一括提供型)の光回線を取得する API

path Parameters

ipoeId

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/ipoe/hikari-collabo/{ipoeId}

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo/{ipoeId}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"postalCode": "100-0000",
"address": "東京都港区港南１丁目９−１",
"ref": "/v1/ipoe/hikari-collabo/Z123456789",
"fieldSurveyRequirement": true,
"ticketIssueRequirement": false,
"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",
"customerNote": "光コラボ回線1",
"fletsOrderType": "new",
"fletsType": "family200M",
"ipoeType": "normal",
"appControl": false,
"installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
"onSiteRepairOption": true,
"constructionOption": 
{"siteRouteSurvey": true,
"lineConfirmation": true,
"wiringRouteConstruction": true,
"constructionResultReport": true,
"photographConsent": true,
"photographConsentName": "山田　太郎",
"specifiedVisitDateTime": true
},
"fieldSurvey": 
{"type": "fieldSurvey",
"date": "2022-02-02",
"time": "9-10",
"admissionApplicationInfo": "companyInfoAndWorkCandidateName",
"attendanceCompanyName": "ＮＴＴコミュニケーションズ",
"attendanceDepartmentName": "プラットフォームサービス本部",
"attendancePersonName": "山田　太郎",
"attendancePersonNameKana": "ヤマダ　タロウ",
"attendancePhoneNumber": "03-1234-5678"
},
"constrcution": 
{"type": "construction",
"date": "2022-02-02",
"time": "9-10",
"admissionApplicationInfo": "companyInfoAndWorkCandidateName",
"attendanceCompanyName": "ＮＴＴコミュニケーションズ",
"attendanceDepartmentName": "プラットフォームサービス本部",
"attendancePersonName": "山田　太郎",
"attendancePersonNameKana": "ヤマダ　タロウ",
"attendancePhoneNumber": "03-1234-5678"
}
}

光コラボ回線更新API

ベストエフォートIPoE接続(光一括提供型)の光回線を更新する API

path Parameters

ipoeId

required

string

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

customerNote	string
ipoeType	string Enum: "normal" "wide" ベストエフォートIPoE接続 normal: 標準 wide: ワイド
changeEffectiveDate	string <date> 光回線24時間出張修理オプションの変更の反映希望日。onSiteRepairOption を変更するときは指定必須。 10暦日以降から指定可能。ただし12/29～1/3は暦日に含まない。
appControl	boolean ワイドプラス for Web会議の利用有無。ベストエフォートIPoE接続のプランがワイドの場合のみ利用可。
onSiteRepairOption	boolean 光回線24時間出張修理オプション変更が適用された月は変更不可。開通時、Trueを指定した場合、開通月には変更できない。 contractor(契約者情報)と同時に変更は不可、契約者情報変更のオーダーが存在する場合はエラーとなる。 true: あり false: なし

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/ipoe/hikari-collabo/{ipoeId}

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo/{ipoeId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customerNote": "IPoE回線1",
"ipoeType": "wide",
"changeEffectiveDate": "2022-02-02",
"appControl": true,
"onSiteRepairOption": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"customerNote": "光コラボ回線1",
"postalCode": "100-0000",
"address": "東京都港区港南１丁目９−１",
"ref": "/v1/ipoe/hikari-collabo/Z123456789",
"fieldSurveyRequirement": true,
"ticketIssueRequirement": false,
"tenantId": "550e8400e29b41d4a716446655440000",
"resourceStatus": "active",
"orderId": "550e8400e29b41d4a716446655440000",
"orderStatus": "completed",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartTime": "2019-05-21T10:05:48+09:00",
"fletsOrderType": "new",
"fletsType": "family200M",
"ipoeType": "wide",
"appControl": true,
"installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
"onSiteRepairOption": true,
"changeEffectiveDate": "2022-02-02"
}

光コラボ回線廃止API

ベストエフォートIPoE接続(光一括提供型)の光回線を廃止する API

path Parameters

ipoeId

required

string

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

collectType required	string Enum: "visit" "kit" レンタル機器（ONU）回収方法 visit：作業者が訪問して回収 kit：返送キットによる回収
lanCollect	boolean Default: false LANケーブルなどONU以外の回収希望 collectTypeがvisitの場合に設定必須、kitの場合は不要 true: 回収を希望 false: 回収を希望しない
kitSendInstallAddressSame	boolean 回収キット送付先住所が回線設置場所住所と同一。true：同一、false：異なる
kitSendAddress	object 回収キット送付先住所情報。collectTypeがkitの場合、かつkitSendInstallAddressSameがfalseの場合に必須

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/ipoe/hikari-collabo/{ipoeId}

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo/{ipoeId}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"collectType": "kit",
"kitSendInstallAddressSame": false,
"kitSendAddress": 
{"companyName": "NTTコミュニケーションズ",
"personName": "山田　太郎",
"addressCode": "13104070003",
"address": "東京都新宿区西新宿３丁目",
"houseNumber": "１９−２−５",
"buildingName": "山田ビル"
}
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"ipoeId": "Z123456789",
"customerNote": "光コラボ回線1",
"postalCode": "100-0000",
"address": "東京都港区港南１丁目９−１",
"ref": "/v1/ipoe/hikari-collabo/Z123456789",
"ipv4Address": "192.0.2.1/32",
"tenantId": "550e8400e29b41d4a716446655440000",
"resourceStatus": "active",
"orderId": "550e8400e29b41d4a716446655440000",
"orderStatus": "completed",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartTime": "2019-05-21T10:05:48+09:00",
"fletsOrderType": "new",
"fletsType": "family200M",
"ipoeType": "normal",
"appControl": false,
"addressCode": 12345678901,
"onSiteRepairOption": true,
"removal": 
{"collectType": "kit",
"kitSendInstallAddressSame": false,
"kitSendAddress": 
{"companyName": "NTTコミュニケーションズ",
"personName": "山田　太郎",
"addressCode": "13104070003",
"address": "東京都新宿区西新宿３丁目",
"houseNumber": "１９−２−５",
"buildingName": "山田ビル"
}
}
}

現地調査日、宅内工事日、撤去日照会API

現地調査日、宅内工事日、訪問回収日の可能日を照会するAPI

path Parameters

ipoeId

required

string

query Parameters

yearMonth	string Example: yearMonth=2023-06 照会月を指定する。5ヶ月後の月まで指定可能。照会月を指定しない場合、予約可能な最短日からその月の末日までの空き状況を返却する。最短日より前の月を指定した場合、400エラーを返す。
type required	string Enum: "fieldSurvey" "constrction" "removal" Example: type=fieldSurvey 工事タイプを指定 fieldSurvey：現地調査日予約の場合に指定 constrction：宅内工事日予約の場合に指定 removal：訪問回収日予約の場合に指定

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/ipoe/hikari-collabo/{ipoeId}/search-date

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo/{ipoeId}/search-date

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"constructionDates": 
[
{"scheduledDate": "2022-02-02",
"scheduledTimes": 
[
{"scheduledTime": "9-10"
}
]
}
]
}

現地調査日、宅内工事日、撤去日予約API

現地調査日、宅内工事日、訪問回収日を予約するAPI

光回線の新設時は、typeがfieldSurvey, construction双方の予約が必須
- ただし、fieldSurveyRequirementがfalseの場合は、typeがconstructionの予約のみ必要

path Parameters

ipoeId

required

string

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

type required	string Enum: "fieldSurvey" "construction" "removal" 工事種別
date required	string <date> 日付 ISO8601 の拡張形式 (YYYY-MM-DD)
time required	string Enum: "9-12" "9-10" "10-12" "13-17" "13-14" "13-15" "15-17" 時間帯 9-12: 09:00-12:00 9-10: 09:00-10:00 10-12: 10:00-12:00 13-17: 13:00-17:00 13-14: 13:00-14:00 13-15: 13:00-15:00 15-17: 15:00-17:00
admissionApplicationInfo required	string Enum: "noApplication" "companyInfo" "companyInfoAndWorkCandidateName" 入館に必要な情報 noApplication：不要 companyInfo：作業会社情報(会社名、代表者名、電話番号) companyInfoAndWorkCandidateName：作業会社情報(会社名、代表者名、電話番号)と作業候補者名
attendanceCompanyName required	string [ 1 .. 15 ] characters 立会者の会社名
attendanceDepartmentName required	string [ 1 .. 20 ] characters 立会者の部課名
attendancePersonName required	string [ 1 .. 16 ] characters 立会者の氏名
attendancePersonNameKana required	string [ 1 .. 32 ] characters 立会者の氏名カナ
attendancePhoneNumber required	string <= 13 characters ^0[5789]0-[0-9]{4}-[0-9]{4}$\|^0([0-9]-[0-9]{4}\|[0-9]{2}-[0-9]{3}\|[0-9]{3}-[0-9]{2}\|[0-9]{4}-[0-9])-[0-9]{4}$ 立会者の連絡先、ハイフン必須

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/ipoe/hikari-collabo/{ipoeId}/reserve-date

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo/{ipoeId}/reserve-date

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"type": "fieldSurvey",
"date": "2022-02-02",
"time": "9-10",
"admissionApplicationInfo": "companyInfoAndWorkCandidateName",
"attendanceCompanyName": "ＮＴＴコミュニケーションズ",
"attendanceDepartmentName": "プラットフォームサービス本部",
"attendancePersonName": "山田　太郎",
"attendancePersonNameKana": "ヤマダ　タロウ",
"attendancePhoneNumber": "03-1234-5678"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"type": "fieldSurvey",
"date": "2022-02-02",
"time": "9-10",
"admissionApplicationInfo": "companyInfoAndWorkCandidateName",
"attendanceCompanyName": "ＮＴＴコミュニケーションズ",
"attendanceDepartmentName": "プラットフォームサービス本部",
"attendancePersonName": "山田　太郎",
"attendancePersonNameKana": "ヤマダ　タロウ",
"attendancePhoneNumber": "03-1234-5678"
}

住所検索

ベストエフォートIPoE接続(光一括提供型)の光回線を引く、設置場所住所を（都道府県、市区郡町村、大字・通称、字・丁目、番地、建物）を取得するAPI
取得した設置場所住所は、サービスの提供判定や注文登録などに確認するために利用する

header Parameters

X-Auth-Token

required

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

Example: dc03494823a841338430052e9ee95e07

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

Request Body schema: application/json

buildingType required	string Enum: "house" "apartment" 建物種別戸建／集合住宅示す区分を設定 house：戸建て/ファミリータイプ、apartment：集合住宅/マンションタイプ
postalCode	string ^[0-9]{3}-[0-9]{4}$ 郵便番号郵便番号、都道府県のいずれかを必ず設定。ハイフンあり
prefecture	string [ 1 .. 4 ] characters 都道府県郵便番号、都道府県のいずれかを必ず設定
municipality	string [ 1 .. 12 ] characters 市区郡町村該当項目に“住所なし” という固定文言を設定すると「市区郡町村名無し」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
largerSection	string [ 1 .. 18 ] characters 大字・通称該当項目に“住所なし” という固定文言を設定すると「大字・通称名無し」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
section	string [ 1 .. 12 ] characters 字・丁目該当項目に“住所なし” という固定文言を設定すると「字・丁目名無し」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
houseNumber1	string [ 1 .. 20 ] characters 番地・号１該当項目に“住所なし” という固定文言を設定すると「なし」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
houseNumber2	string [ 1 .. 10 ] characters 番地・号２該当項目に“住所なし” という固定文言を設定すると「なし」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
houseNumber3	string [ 1 .. 10 ] characters 番地・号３該当項目に“住所なし” という固定文言を設定すると「なし」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
buildingName1	string [ 1 .. 20 ] characters 建物名１該当項目に“住所なし” という固定文言を設定すると「なし」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
buildingName2	string [ 1 .. 10 ] characters 建物名２該当項目に“住所なし” という固定文言を設定すると「なし」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
buildingName3	string [ 1 .. 10 ] characters 建物名３該当項目に“住所なし” という固定文言を設定すると「なし」を条件に検索を行う該当項目をタグ無で連携すると検索条件に含めない
buildingFacilityName	string [ 1 .. 30 ] characters 建物設備名 buildingTypeがapartmentの場合必須、houseの場合不要

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/ipoe/hikari-collabo-util/search-address

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo-util/search-address

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"buildingType": "apartment",
"postalCode": "160-0023",
"prefecture": "東京都",
"municipality": "新宿区",
"largerSection": "西新宿",
"section": "３丁目",
"houseNumber1": "１９",
"houseNumber2": "２",
"houseNumber3": "５",
"buildingName1": "山田ビル１",
"buildingName2": "山田ビル２",
"buildingName3": "大和ハイツ"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"buildingType": "apartment",
"postalCode": "160-0023",
"prefecture": "東京都",
"municipalityList": 
["新宿区"
],
"largerSectionList": 
["西新宿"
],
"sectionList": 
["３丁目"
],
"houseNumber1List": 
["１９"
],
"houseNumber2List": 
["２"
],
"houseNumber3List": 
["５"
],
"buildingName1List": 
["山田ビル１"
],
"buildingName2List": 
["山田ビル２"
],
"buildingName3List": 
["大和ハイツ"
],
"installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
"addressCode": "12345678901"
}

提供判定

設置場所住所で提供可能なサービスを確認するAPI

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/ipoe/hikari-collabo-util/judge

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo-util/judge

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"installationPlaceCode": "212dd263522c4e73887212edfc7273e6"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"installationPlaceCode": "212dd263522c4e73887212edfc7273e6",
"judgeResultList": 
[
{"fletsType": "family200M",
"result": "constructionPossible"
}
],
"fieldSurveyRequirement": true
}

光コラボ受付可否取得API

ベストエフォートIPoE接続(光一括提供型)の光回線の申込が可能かを取得するAPI

header Parameters

X-Auth-Tokens

required

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/ipoe/hikari-collabo-util/available

https://api.ntt.com/sdpf-ztgict/v1/ipoe/hikari-collabo-util/available

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"available": true
}

ipoe

IPoE回線一覧取得API

IPoE回線一覧取得

query Parameters

limit	integer [ 1 .. 100 ] Default: 10 Example: limit=50 ページあたりの表示件数の指定（デフォルト10, 最大100）
offset	integer >= 0 Default: 0 Example: offset=5 表示するページ番号の指定（デフォルト0）
ipoeId	string <= 100 characters ^Z[0-9]{9}$ Example: ipoeId=Z123456789 IPoE回線リソースのID. 指定なしならテナント内のすべてのルーターリソースが検索対象. 複数指定も可能. 複数指定の場合の例: ipoeId=Z123456788&ipoeId=Z1234556789
customerNote	string customerNoteの部分一致検索
sortKey	string Enum: "ipoeId" "customerNote" "ipv4Address" "fletsId" "terminalId" "resourceStatus" "orderId" "updateTime" "ipoeType" "appControl" ソート項目の指定. レスポンスボディの項目から
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/ipoe

https://api.ntt.com/sdpf-ztgict/v1/ipoe

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"ipoes": 
[
{"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",
"ipoeId": "Z123456789",
"fletsId": "CAF0123456789",
"ipv4Address": "192.0.2.1/32",
"customerNote": "IPoE回線1",
"ipoeType": "normal",
"appControl": false,
"ref": "/v1/ipoe/hikari-collabo/Z123456789",
"terminalId": "Z123456789"
}
]
}