Service Order API

Overview

This API allows you to control NTT Com Service Order.

Resource URL

Please use global common domain, or the individual region domain.

If you want to use the global common domain, depending on the circumstances of your available points, your request connect to the nearest API gateway.

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

Resource Information

• #1 implement appropriate flow restriction in the customer connection unit

Check Service Order Status

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
           "orderRequestId":"************"
            }
       ]
    "resultCount":1
}

Check Service Order Detailed Information

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

This API is served for Service Order Detailed Information.
This API is available at 9:00 - 17:30(JST) of business day.
If you would use this API, you need to ask our sales parson or contact page after login.
When you login the developer portal, please select "Apply for service order detail API" at "Types".

contact page

Request　Parameters

※1,2 If you request without "Update Date(from)" and "Update Date(to)", APIGW sets "one month ago from request date" to "Update Date(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"
        }
    ]
}