Professional Support Services - Flexible InterConnect API リファレンス (1.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

ベーシックプラス（有料）への変更・参照・廃止、それに加えてオプション(メンテナンス詳細通知)をメールで取得する事が可能であり、そちらの有効化等の操作に関するAPIドキュメントです。

Professional-Support-Services

List Professional Support Services

ベーシックプラス（有料）の情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F510123456789 ベーシックプラス（有料）のID

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/professional-support-services

https://api.ntt.com/fic-eri/v1/professional-support-services

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"professionalSupportServices": 
[
{"id": "F510123456789",
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Processing",
"currentMenu": "BasicPlus",
"menus": 
[
{"menu": "BasicPlus",
"menuStartDate": "2022-10-25T10:30:00Z",
"option1": 
{"status": true,
"startDate": "2022-10-26T06:51:00Z",
"endDate": null
}
}
]
}
]
}

Create Professional Support Service

ベーシックプラス（有料）へサポートメニューを変更します。

(ご利用開始時は「ベーシック（無料）」が自動で適用されます。)

また、ベーシックプラス（有料）は1テナントにつき1契約のみとなります。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

Request Body schema: application/json

professionalSupportService

required

object

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/professional-support-services

https://api.ntt.com/fic-eri/v1/professional-support-services

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"professionalSupportService": 
{"currentMenu": "BasicPlus",
"menus": 
[
{"option1": 
{"status": false
}
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"professionalSupportService": 
{"id": "F510123456789",
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Processing",
"currentMenu": "BasicPlus",
"menus": 
[
{"menu": "BasicPlus",
"menuStartDate": null,
"option1": 
{"status": false,
"startDate": null,
"endDate": null
}
}
],
"operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}

Show Professional Support Service

指定したベーシックプラス（有料）の詳細情報を取得します。

path Parameters

required

string

対象ベーシックプラス（有料）のID

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/professional-support-services/{id}

https://api.ntt.com/fic-eri/v1/professional-support-services/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"professionalSupportService": 
{"id": "F510123456789",
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Processing",
"currentMenu": "BasicPlus",
"menus": 
[
{"menu": "BasicPlus",
"menuStartDate": "2022-10-25T10:30:00Z",
"option1": 
{"status": true,
"startDate": "2022-10-27T12:00:00Z",
"endDate": null
}
}
]
}
}

Update Professional Support Service

ベーシックプラス（有料）のオプションを変更します。

オプションに関する詳細はこちらをご参照下さい。

path Parameters

required

string

対象ベーシックプラス（有料）のID

Request Body schema: application/json

professionalSupportService

required

object

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/professional-support-services/{id}

https://api.ntt.com/fic-eri/v1/professional-support-services/{id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"professionalSupportService": 
{"currentMenu": "BasicPlus",
"menus": 
[
{"option1": 
{"status": true
}
}
]
}
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"professionalSupportService": 
{"id": "F510123456789",
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Processing",
"currentMenu": "BasicPlus",
"menus": 
[
{"menu": "BasicPlus",
"menuStartDate": "2022-10-25T10:30:00Z",
"option1": 
{"status": true,
"startDate": null,
"endDate": null
}
}
],
"operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}

Delete Professional Support Service

ベーシックプラス（有料）を廃止します。廃止時は紐づくオプションも廃止となります。

path Parameters

required

string

対象ベーシックプラス（有料）のID

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/professional-support-services/{id}

https://api.ntt.com/fic-eri/v1/professional-support-services/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"professionalSupportService": 
{"id": "F510123456789",
"tenantId": "db8b0e40743f460685040c46167cf19e",
"operationStatus": "Processing",
"currentMenu": "BasicPlus",
"menus": 
[
{"menu": "BasicPlus",
"menuStartDate": "2022-10-25T10:30:00Z",
"option1": 
{"status": true,
"startDate": "2022-10-27T12:00:00Z",
"endDate": null
}
}
],
"operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}