Documentation Powered by ReDoc

docomo business SIGN MAXIV APIリファレンス (1.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com License: NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

docomo business SIGN MAXIV APIリファレンス

MAXIV用API

MAXIV契約を行うAPI

MAXIV契約

MAXIV契約を行います。

path Parameters
tenantId
required
string 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
companyName
required
string

企業名

adminEmail
required
string <email> ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$

初期管理者のメールアドレス

period
required
integer
Enum: 1 3 6

データ保存期間

quantity
required
integer

利用デバイス数

Responses

202

Accepted.

400

Bad Request

409

Conflict

500

Internal Server Error

post/tenants/{tenantId}/maxiv
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/maxiv

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "companyName": "テスト会社",
  • "adminEmail": "user@example.com",
  • "period": 1,
  • "quantity": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "companyName": "テスト会社",
  • "adminEmail": "user@example.com",
  • "period": 1,
  • "quantity": 0,
  • "createdAt": "2024-06-10T06:30:30Z"
}

MAXIV契約取得

MAXIV契約情報を取得します。

path Parameters
tenantId
required
string 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

200

OK.

400

Bad Request

404

Not Found

500

Internal Server Error

get/tenants/{tenantId}/maxiv
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/maxiv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "companyName": "テスト会社",
  • "adminEmail": "user@example.com",
  • "period": 1,
  • "quantity": 0,
  • "createdAt": "2024-06-10T06:30:30Z"
}

MAXIV解約

MAXIV契約を廃止します。

path Parameters
tenantId
required
string 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

204

No Content

400

Bad Request

404

Not Found

500

Internal Server Error

delete/tenants/{tenantId}/maxiv
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/maxiv

Response samples

Content type
application/json
Example
example-iotneoError
Copy
 Expand all Collapse all
{
  • "errorCode": 10104,
  • "errorMessages":
    [
    ]
}