Professional Support Services - Flexible InterConnect API リファレンス (1.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
ベーシックプラス(有料)への変更・参照・廃止、それに加えてオプション(メンテナンス詳細通知)をメールで取得する事が可能であり、そちらの有効化等の操作に関するAPIドキュメントです。
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
- 200
Content type
application/json
Example
List(ベーシックプラス(有料)にお申し込みしているテナントの場合)
Copy
Expand all Collapse all {- "professionalSupportServices": [
- {
- "id": "F510123456789",
- "currentMenu": "BasicPlus",
- "menus": [
- {
- "menu": "BasicPlus",
- "menuStartDate": "2022-10-25T10:30:00Z",
- "option1": {
- "status": true,
- "startDate": "2022-10-26T06:51:00Z",
- "endDate": null
}
}
], - "tenantId": "db8b0e40743f460685040c46167cf19e",
- "operationStatus": "Processing"
}
]
}
Create Professional Support Service
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
- 202
Content type
application/json
Copy
Expand all Collapse all {- "professionalSupportService": {
- "id": "F510123456789",
- "currentMenu": "BasicPlus",
- "menus": [
- {
- "menu": "BasicPlus",
- "menuStartDate": null,
- "option1": {
- "status": false,
- "startDate": null,
- "endDate": null
}
}
], - "tenantId": "db8b0e40743f460685040c46167cf19e",
- "operationStatus": "Processing",
- "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Show Professional Support Service
指定したベーシックプラス(有料)の詳細情報を取得します。
path Parameters
id required | string |
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
- 200
Content type
application/json
Copy
Expand all Collapse all {- "professionalSupportService": {
- "id": "F510123456789",
- "currentMenu": "BasicPlus",
- "menus": [
- {
- "menu": "BasicPlus",
- "menuStartDate": "2022-10-25T10:30:00Z",
- "option1": {
- "status": true,
- "startDate": "2022-10-27T12:00:00Z",
- "endDate": null
}
}
], - "tenantId": "db8b0e40743f460685040c46167cf19e",
- "operationStatus": "Processing"
}
}
Update Professional Support Service
ベーシックプラス(有料)のオプションを変更します。
オプションに関する詳細はこちらをご参照下さい。
path Parameters
id required | string |
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
- 202
Content type
application/json
Example
option1を有効に変更
Copy
Expand all Collapse all {- "professionalSupportService": {
- "id": "F510123456789",
- "currentMenu": "BasicPlus",
- "menus": [
- {
- "menu": "BasicPlus",
- "menuStartDate": "2022-10-25T10:30:00Z",
- "option1": {
- "status": true,
- "startDate": null,
- "endDate": null
}
}
], - "tenantId": "db8b0e40743f460685040c46167cf19e",
- "operationStatus": "Processing",
- "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Delete Professional Support Service
ベーシックプラス(有料)を廃止します。 廃止時は紐づくオプションも廃止となります。
path Parameters
id required | string |
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
- 202
Content type
application/json
Copy
Expand all Collapse all {- "professionalSupportService": {
- "id": "F510123456789",
- "currentMenu": "BasicPlus",
- "menus": [
- {
- "menu": "BasicPlus",
- "menuStartDate": "2022-10-25T10:30:00Z",
- "option1": {
- "status": true,
- "startDate": "2022-10-27T12:00:00Z",
- "endDate": null
}
}
], - "tenantId": "db8b0e40743f460685040c46167cf19e",
- "operationStatus": "Processing",
- "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}