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では、テナント共通の設定の参照・操作が可能です。

settings

契約者情報取得API

テナント内で共通的に利用する契約者情報を取得するAPI

header Parameters
X-Auth-Tokens
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/contractor
https://api.ntt.com/sdpf-ztgict/v1/settings/contractor

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "NTTコミュニケーションズ　株式会社",
  • "nameKana": "エヌティティコミュニケーションズ　カブシキガイシャ",
  • "picName": "山田　太郎",
  • "picNameKana": "ヤマダ　タロウ",
  • "postalCode": "160-0023",
  • "address": "東京都新宿区西新宿3丁目",
  • "houseNumber": "１９−２−５",
  • "buildingName": "山田ビル",
  • "addressKana": "トウキョウトニシシンジュク３チョウメ１９－２－５ヤマダビル",
  • "phoneNumber": "03-1234-5678",
  • "addressCode": "13104070003",
  • "orderId": "550e8400e29b41d4a716446655440000"
}

契約者情報変更API

テナント内で共通的に利用する契約者情報を変更するAPI

header Parameters
X-Auth-Tokens
string

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

Request Body schema: application/json
name
required
string [ 1 .. 41 ] characters

法人名 全角のみ許容、全角スペース必須、以下の場合エラーとなる

  • 先頭が全角スペース
  • 末尾が全角スペース
  • 全角スペースが存在しない
  • 2個連続した全角スペースが存在する
  • 最初の全角スペースより前が21文字以上
  • 最初の全角スペースより後が21文字以上
nameKana
required
string [ 1 .. 41 ] characters

法人名カナ 全角のみ許容、全角スペース必須、以下の場合エラーとなる

  • 先頭が全角スペース
  • 末尾が全角スペース
  • 全角スペースが存在しない
  • 2個連続した全角スペースが存在する
  • 最初の全角スペースより前が21文字以上
  • 最初の全角スペースより後が21文字以上
picName
required
string [ 1 .. 20 ] characters

担当者名 全角のみ許容、全角スペース必須 ベストエフォートIPoE接続(光一括提供型型)の申込で利用する

picNameKana
required
string [ 1 .. 35 ] characters

担当者名カナ 全角のみ許容、全角スペース必須 ベストエフォートIPoE接続(光一括提供型型)の申込で利用する

postalCode
required
string ^[0-9]{3}-[0-9]{4}$

郵便番号。ハイフンあり

address
required
string

住所（都道府県市町村丁目）、全角のみ許容

houseNumber
required
string

住所（番地・号）、全角のみ許容

buildingName
string

住所（建物名）、全角のみ許容

addressKana
required
string

住所カナ、全角のみ許容

phoneNumber
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}$

電話番号、ハイフン必須

addressCode
string 11 characters ^[0-9]{11}$

住所検索で設定された住所コード。ベストエフォートIPoE接続(光一括提供型型)の申し込みを行う場合に必要。

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/settings/contractor
https://api.ntt.com/sdpf-ztgict/v1/settings/contractor

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "NTTコミュニケーションズ　株式会社",
  • "nameKana": "エヌティティコミュニケーションズ　カブシキガイシャ",
  • "picName": "山田　太郎",
  • "picNameKana": "ヤマダ　タロウ",
  • "postalCode": "160-0023",
  • "address": "東京都新宿区西新宿３丁目",
  • "houseNumber": "１９−２−５",
  • "buildingName": "山田ビル",
  • "addressKana": "トウキョウトニシシンジュク３チョウメ１９－２－５ヤマダビル",
  • "phoneNumber": "03-1234-5678",
  • "addressCode": "13104070003"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "NTTコミュニケーションズ　株式会社",
  • "nameKana": "エヌティティコミュニケーションズ　カブシキガイシャ",
  • "picName": "山田　太郎",
  • "picNameKana": "ヤマダ　タロウ",
  • "postalCode": "160-0023",
  • "address": "東京都新宿区西新宿3丁目",
  • "houseNumber": "１９−２−５",
  • "buildingName": "山田ビル",
  • "addressKana": "トウキョウトニシシンジュク３チョウメ１９－２－５ヤマダビル",
  • "phoneNumber": "03-1234-5678",
  • "addressCode": "13104070003",
  • "orderId": "550e8400e29b41d4a716446655440000"
}

電話対応（チケット起票代行）情報取得API

電話対応（チケット起票代行）情報を取得するAPI

header Parameters
X-Auth-Tokens
required
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/phone-ticketing-support
https://api.ntt.com/sdpf-ztgict/v1/settings/phone-ticketing-support

Response samples

Content type
application/json
Example
利用前/廃止後
Copy
 Expand all Collapse all
{
  • "enabled": false
}

電話対応（チケット起票代行）変更申し込みAPI

電話対応（チケット起票代行）情報を変更するAPI

header Parameters
X-Auth-Tokens
required
string

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

Request Body schema: application/json
picName
string

お客様担当者名

picPhoneNumber
string

お客様担当者連絡先

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/settings/phone-ticketing-support
https://api.ntt.com/sdpf-ztgict/v1/settings/phone-ticketing-support

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "picName": "東京 太郎",
  • "picPhoneNumber": "090-1234-5678"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "supportId": "string",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "effectiveDate": "2019-05-21",
  • "picName": "東京 太郎",
  • "picPhoneNumber": "090-1234-5678",
  • "supportPhoneNumber": "090-1234-5678"
}

電話対応（チケット起票代行）新規申し込みAPI

電話対応（チケット起票代行）新規申し込みAPI

header Parameters
X-Auth-Tokens
required
string

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

Request Body schema: application/json
effectiveDate
required
string <date>

利用開始日時 10歴日後から指定可能

picName
required
string

お客様担当者名

picPhoneNumber
required
string

お客様担当者連絡先

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/settings/phone-ticketing-support
https://api.ntt.com/sdpf-ztgict/v1/settings/phone-ticketing-support

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "effectiveDate": "2019-05-21",
  • "picName": "東京 太郎",
  • "picPhoneNumber": "090-1234-5678"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": false,
  • "supportId": "string",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "effectiveDate": "2019-05-21",
  • "picName": "東京 太郎",
  • "picPhoneNumber": "090-1234-5678"
}

電話対応（チケット起票代行）廃止申し込みAPI

電話対応（チケット起票代行）廃止申し込みAPI

header Parameters
X-Auth-Tokens
required
string

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

Request Body schema: application/json
effectiveDate
required
string <date>

廃止日 10歴日後から指定可能

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/settings/phone-ticketing-support
https://api.ntt.com/sdpf-ztgict/v1/settings/phone-ticketing-support

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "effectiveDate": "2019-05-21"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enabled": true,
  • "supportId": "string",
  • "orderId": "550e8400e29b41d4a716446655440000",
  • "orderStatus": "applied",
  • "effectiveDate": "2019-05-21",
  • "picName": "東京 太郎",
  • "picPhoneNumber": "090-1234-5678",
  • "supportPhoneNumber": "090-1234-5678"
}

モバイル情報取得API

ドコモ回線情報を取得するAPI

header Parameters
X-Auth-Tokens
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/mobile
https://api.ntt.com/sdpf-ztgict/v1/settings/mobile

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mobileDiscountCode": "5GT-ZABCDEFG",
  • "mobileTermsOfServiceAccepted": true,
  • "mobileRepresentativeNumber": "03-1234-5678"
}

モバイル情報変更API

ドコモ回線情報を変更するAPI

Request Body schema: application/json
mobileDiscountCode
string ^5G(O-U|[TMP]-[ZTSNWF])[0-9a-zA-Z]{7}$

5Gディスカウントキー。既存のディスカウントキーを削除する場合は空文字を入力する。ドコモ5Gサービスに関する契約約款同意済みの場合変更不可。

existingPhoneNumber
string

一括請求代表番号。当サービスで初めてモバイル回線を申し込む際、既に docomo で既設の回線契約がある場合はその番号を記載する必要がある。

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/settings/mobile
https://api.ntt.com/sdpf-ztgict/v1/settings/mobile

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mobileDiscountCode": "5GT-ZABCDEFG"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mobileDiscountCode": "5GT-ZABCDEFG",
  • "mobileTermsOfServiceAccepted": true,
  • "mobileRepresentativeNumber": "03-1234-5678",
  • "orderId": "550e8400e29b41d4a716446655440000"
}

モバイル約款表示API

ドコモ5Gサービスに関する契約約款を表示するAPI

header Parameters
X-Auth-Tokens
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/mobile/mobile-terms-of-service
https://api.ntt.com/sdpf-ztgict/v1/settings/mobile/mobile-terms-of-service

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "agreementCode": "aGaXXDPADqs=",
  • "termsOfService":
    {
    }
}

モバイル約款同意API

ドコモ5Gサービスに関する契約約款に同意するAPI

Request Body schema: application/json
agreementCode
string

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/settings/mobile/mobile-terms-of-service/agree
https://api.ntt.com/sdpf-ztgict/v1/settings/mobile/mobile-terms-of-service/agree

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "agreementCode": "string"
}

トラフィック収集の同意設定

トラフィックデータの同意設定を取得するAPI

header Parameters
X-Auth-Tokens
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/traffic-monitoring
https://api.ntt.com/sdpf-ztgict/v1/settings/traffic-monitoring

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "termsOfServiceAccepted": true
}

トラフィック収集の約款表示API

トラフィックデータの約款を表示するAPI

header Parameters
X-Auth-Tokens
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/traffic-monitoring/terms-of-service
https://api.ntt.com/sdpf-ztgict/v1/settings/traffic-monitoring/terms-of-service

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "agreementCode": "aGaXXDPADqs=",
  • "termsOfService":
    {
    }
}

トラフィック収集の約款同意API

トラフィックデータのドコモ5Gサービスに関する契約約款に同意するAPI

Request Body schema: application/json
agreementCode
required
string

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/settings/traffic-monitoring/terms-of-service/agree
https://api.ntt.com/sdpf-ztgict/v1/settings/traffic-monitoring/terms-of-service/agree

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "agreementCode": "string"
}

有償マネージドサービスAPI

Professional Support Service(PSS)の情報を取得するAPI

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/settings/paid-managed-service
https://api.ntt.com/sdpf-ztgict/v1/settings/paid-managed-service

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "paid-managed-service":
    [
    ]
}

約款文書ダウンロード用API

ドコモ5Gサービスに関する契約約款文書ダウンロード用API

query Parameters
documentId
required
string ^[a-f0-9]{32}$
Example: documentId=1e115026499c42d783b53c04b4808f1e

書類ID。ダウンロードする対象の書類IDを指定する。

header Parameters
X-Auth-Token
required
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/download-terms-of-service
https://api.ntt.com/sdpf-ztgict/v1/download-terms-of-service

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "documentId": "1e115026499c42d783b53c04b4808f1e",
  • "decoding": "base64",
  • "content": "dGVybXMgb2Ygc2VydmljZQo=",
  • "format": "html",
  • "md5": "ec20cf5b160330ef73c92968661f74ad"
}