サービスオーダ API

Overview

本APIは、NTT Com各種サービスのサービス契約オーダ情報を管理するAPIです。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/service-orders

2.Base Path(Region)

https://{region}.api.ntt.com/v1/business-process/service-orders

region is jp|us|fr|sg
e.g. https://us.api.ntt.com/v1/business-process/service-orders
指定できるregionは、将来拡充予定

Resource Information

Key	Value
レスポンスフォーマット	JSON
認証(OAuth)	Yes
帯域制御#1	Yes

#1 お客さま接続単位で適切な流量制限を実施

サービス契約オーダ進捗状況参照

GET /v1/business-process/service-orders

Request　Parameters

Name	Description	type	mandatory
serviceName	サービス名称を指定#1	query argument	Yes

#1 uno,ucaas,sip-trunking,mss,050plusbiz,ip-voice,smart-pbx,accs,bdp-e

Example Request

 GET /v1/business-process/service-orders?serviceName=uno

Response Parameters

Name	Description	type	mandatory
contractId	サービスの契約ID	String	Yes
serviceName	サービス名	String	Yes
orderType	オーダタイプ	Int	Yes
offerPlanDate	提供予定日時	String	Yes
orderStatus	オーダステータス	Int	Yes
orderRequestNum	オーダリクエストID	String	Yes
resultCount	レスポンス件数	Int	Yes

orderType

個別サービス	説明
国内Arcstar Universal One	1: 新規 2: 変更 3: 廃止
国際Arcstar Universal One	TBD
BDP-E,MSS,SIP,Trunking,UCaaS	1: 新規 2: 変更 3: 廃止 4: 変更(SIP Trunking,UCaaSのみ)

orderStatus

個別サービス	説明
国内Arcstar Universal One	1: 受付済 2: 現地調査完了 3: アクセス回線工事完了 4: 端末工事完了 5: 完了
国際Arcstar Universal One	TBD
BDP-E	1: 進行中 2: 完了
MSS	1: 進行中返却なし: 完了
SIP Trunking, UCaaS	1: 進行中

Example Result

{
    "items":
        [
          {
           "contractId":"N********",
           "serviceName":"uno-virtual",
           "orderType":1,
           "offerPlanDate":"2014-10-31T12:34:56Z",
           "orderStatus":1
           "orderRequestNum":"************"
            }
       ]
    "resultCount":1
}

サービス契約オーダ詳細情報参照

GET /v1/business-process/service-order-details

サービス契約オーダ進捗詳細状況参照 API のサービス提供時間は、営業日 9:00〜17:30（日本時間）になります。
サービス契約オーダ進捗詳細状況参照 API のご利用には、事前に別途お申し込みが必要になります。
詳しくは、弊社営業担当者または開発者ポータルにログイン頂き、メニューバーの『サポート』→『お問い合わせ』からお問い合わせ下さい。
『問い合わせカテゴリ』は、『サービス契約オーダ詳細情報参照 APIのお申し込み』を選択下さい。

契約済お客さま専用問い合わせページ

Request　Parameters

Name	Description	type
webentry_id	WebエントリID	query argument
n_no	サービスの契約ID	query argument
v_no	VPNグループID	query argument
data_update_date_from	更新日時（from）※1	query argument
data_update_date_to	更新日時（to）※2	query argument

※1,2 更新日時（from）、更新日時（to）の両方が指定されない場合、リクエスト日時マイナス1ヶ月を更新日時（from）として結果を返します

Example Request

 GET /v1/business-process/service-order-details

Response Parameters

Name	Description	type	mandatory
code	実行結果コード	String	Yes
detailCode	詳細コード	String	Yes
detailMsg	メッセージ	String	Yes
webEntryId	WEBエントリID	String	Yes
changeRelationNum	WEBエントリID枝番	String	Yes
mainBackIdentifier	メイン/バックアップ種別	String	Yes
orderNum	オーダ管理番号	String	Yes
contractVpnNum	顧客ネットワーク番号	String	Yes
contractLineNumAppl	契約回線番号（申込）	String	Yes
contractLineNumDistribut	契約回線番号（流通）	String	Yes
darkId	ダーク回線ID	String	Yes
quotationGroupId	相対グループID	String	Yes
applYmd	申込日	String	Yes
itemName	案件名	String	Yes
contractorName	お客様名	String	Yes
officeName	事務所名	String	Yes
kind	オーダ種別	String	Yes
productName	網	String	Yes
serviceName	サービス	String	Yes
accsLineTypeMain	アクセス回線	String	Yes
lineSpeed	回線速度	String	Yes
putPlaceZipNum	ご利用場所郵便番号	String	Yes
putPlaceAddPrefectures	ご利用場所都道府県	String	Yes
putPlaceAdd	ご利用場所住所	String	Yes
putPlaceBuildingName	ご利用場所ビル名	String	Yes
putPlaceFloor	ご利用場所階	String	Yes
putPlaceTel	ご利用場所拠点電話番号	String	Yes
saleChannelCode	販売チャネルコード	String	Yes
customerDepartmentName	お客様対応部門組織区分	String	Yes
supportRequestStatus	支援依頼ステータス	String	Yes
supportRequestActionYmd	支援依頼実施日時	String	Yes
accsConstPresence	アクセス回線工事有無	String	Yes
universalOneTerminal	UniversalOneターミナル	String	Yes
termConstDiv	ターミナル工事区分	String	Yes
holdoutScheduleYmd	開廃希望日	String	Yes
receptYmd	申請日（初回）	String	Yes
changeRelationReceptYmd	申請日（最新）	String	Yes
fieldResearchStatus	現調ステータス	String	Yes
areaFieldResearchScheduleYmd	地域現調希望日	String	Yes
areaFieldResearchTimeZone	地域現調希望時間帯	String	Yes
areaFieldResearchScheduleTimeZone	地域現調予定時間帯	String	Yes
areaFieldResearchWorker	地域現調作業員情報	String	Yes
areaFieldResearchObserver	地域現調立会者情報	String	Yes
areaFieldResearchActionYmd	地域現調実施日時	String	Yes
comFieldResearchTimeZone	弊社現調希望時間帯	String	Yes
comFieldResearchExpectedDay	弊社現調予定日	String	Yes
comFieldResearchExpectedTimeZone	弊社現調予定時間帯	String	Yes
comFieldResearchWorker	弊社現調作業員情報	String	Yes
comFieldResearchObserver	弊社現調立会者情報	String	Yes
comFieldResearchActionYmd	弊社現調実施日時	String	Yes
ancillaryConstPresence	付帯工事実施有無	String	Yes
continuityConstTrialStatus	導通試験ステータス	String	Yes
dfConstHopeYmd	導通工事希望日	String	Yes
continuityConstScheduleYmd	導通工事予定日	String	Yes
continuityConstScheduleTimeZone	導通工事予定時間帯	String	Yes
continuityConstWorker	導通工事作業員情報	String	Yes
continuityConstObserver	導通工事立会者情報	String	Yes
continuityConstActionYmd	導通工事実施日時	String	Yes
homeConstStatus	宅内工事ステータス	String	Yes
accsLineScheduleYmd	宅内工事希望日	String	Yes
homeConstTimeZone	宅内工事希望時間帯	String	Yes
accsLineScheduleTimeZone	宅内工事予定時間帯	String	Yes
homeConstWorker	宅内工事作業員情報	String	Yes
homeConstObserver	宅内工事立会者情報	String	Yes
accsLineActionYmd	宅内工事実施日時	String	Yes
termConstStatus	端末工事ステータス	String	Yes
termConstScheduleYmd	端末工事希望日	String	Yes
termConstHopeTimeZone	端末工事希望時間帯	String	Yes
termConstScheduleTimeZone	端末工事予定時間帯	String	Yes
termConstWorker	端末工事作業員情報	String	Yes
termConstObserver	端末工事立会者情報	String	Yes
termConstActionYmd	端末工事実施日時	String	Yes
withdrawKbn	取下げフラグ	String	Yes

Example Result

{
    "code": 200,
    "detail":{
     "detailCode": "I01",
      "detailMsg": "正常終了しました。（検索結果：1件）" 
    },
    "result": [
        {
            "webEntryId":"UN**********",
            "changeRelationNum":"01",
            "mainBackIdentifier":"1",
            "orderNum":"*************",
            "contractVpnNum":"V********",
            "contractLineNumAppl":"null",
            "contractLineNumDistribut":"N*********",
            "darkId":"null",
            "quotationGroupId":"GU********-****",
            "applYmd":"YYYY/MM/DD",
            "itemName":"****/********",
            "contractorName":"************",
            "officeName":"null",
            "kind":"新設",
            "productName":"Universal One",
            "serviceName":"L2 代表",
            "accsLineTypeMain":"null",
            "lineSpeed":"null",
            "putPlaceZipNum":"null",
            "putPlaceAddPrefectures":"null",
            "putPlaceAdd":"null",
            "putPlaceBuildingName":"null",
            "putPlaceFloor":"null",
            "putPlaceTel":"null",
            "saleChannelCode":"********",
            "customerDepartmentName":"null",
            "supportRequestStatus":"null",
            "supportRequestActionYmd":"null",
            "accsConstPresence":"無し",
            "universalOneTerminal":"null",
            "termConstDiv":"null",
            "holdoutScheduleYmd":"YYYY/MM/DD",
            "receptYmd":"null",
            "changeRelationReceptYmd":"null",
            "fieldResearchStatus":"不要",
            "areaFieldResearchScheduleYmd":"null",
            "areaFieldResearchTimeZone":"不要",
            "areaFieldResearchScheduleTimeZone":"null",
            "areaFieldResearchWorker":"null",
            "areaFieldResearchObserver":"null",
            "areaFieldResearchActionYmd":"null",
            "comFieldResearchTimeZone":"null",
            "comFieldResearchExpectedDay":"null",
            "comFieldResearchExpectedTimeZone":"null",
            "comFieldResearchWorker":"null",
            "comFieldResearchObserver":"null",
            "comFieldResearchActionYmd":"null",
            "ancillaryConstPresence":"null",
            "continuityConstTrialStatus":"不要",
            "dfConstHopeYmd":"null",
            "continuityConstScheduleYmd":"null",
            "continuityConstScheduleTimeZone":"null",
            "continuityConstWorker":"null",
            "continuityConstObserver":"null",
            "continuityConstActionYmd":"null",
            "homeConstStatus":"不要",
            "accsLineScheduleYmd":"null",
            "homeConstTimeZone":"null",
            "accsLineScheduleTimeZone":"null",
            "homeConstWorker":"null",
            "homeConstObserver":"null",
            "accsLineActionYmd":"null",
            "termConstStatus":"不要",
            "termConstScheduleYmd":"null",
            "termConstHopeTimeZone":"null",
            "termConstScheduleTimeZone":"null",
            "termConstWorker":"null",
            "termConstObserver":"null",
            "termConstActionYmd":"null",
            "withdrawKbn":"null"
        }
    ]
}

Overview

Resource URL

Resource Information

サービス契約オーダ進捗状況参照

Request Parameters

Example Request

Response Parameters

orderType

orderStatus

Example Result

サービス契約オーダ詳細情報参照

Request Parameters

Example Request

Response Parameters

Example Result

Request　Parameters

Request　Parameters