サービスオーダ 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

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

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

GET /v1/business-process/service-orders

Request　Parameters

• #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

orderType

orderStatus

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

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

Example Request

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

Response Parameters

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"
        }
    ]
}