Help Center/ Cognitive Engagement Center/ API Reference/ OMA Interface Reference/ Business Software Mall Connection Interfaces/ Querying Customer Information
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Customer Information

Description

This interface is invoked by the business software mall to query business software mall customer information stored on the OMA. (Currently, this interface is provided for the business software mall official website for trial use.)

Method

GET

URI

https://Domain name/rest/oma/softwareconsole/tenant/querytenantbasic (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameter

No.

Parameter

Type

Mandatory or Not

Description

1

X-Auth-Token

String

Yes

Value of access-token of a business software mall user

Response Description

  • Status code: 200
Table 2 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

schema

Object

Yes

Success response code, which indicates that the query is successful

1.1

mobilePhone

String

Yes

Customer mobile number, which has been masked

1.2

company

String

Yes

Customer company name, which has been masked

1.3

customerName

String

Yes

Contact name, which has been masked

1.4

email

String

Yes

Email address, which has been masked

1.5

vdn

String

Yes

VDN

1.6

createDate

Number

Yes

Creation time

1.7

tenantSpaceStatus

String

Yes

Tenant space status

1.8

portalUrl

String

Yes

URL for signing in to the AICC
  • Status code: 401
Table 3 Response body parameter

No.

Parameter

Type

Mandatory or Not

Description

1

schema

String

Yes

Unauthorized operation. 1. Check whether you have purchased services related to the AICC. 2. Sign in to the AICC as a system administrator and check whether the value of Business Software Mall Official Website under System parameters > Unified Public Configuration > Cloud Customers is correct. 3. Check whether the request header parameter is correctly set.
  • Response status code: 502
Table 4 Response body parameter

No.

Parameter

Type

Mandatory or Not

Description

1

schema

String

Yes

The business fails.

Example

  • Scenario: The business software mall invokes this interface to query customer information. 
    URL: /rest/oma/softwareconsole/tenant/querytenantbasic
  • Request header 
    {
    "X-Auth_Token":"0000000000srLl4pnoBc*************9DvgIB87KzYpxMdE9+vvzLZqYIw="
}
  • Response header 
    {
    "connection": "keep-alive", 
    "Content-Length": "16", 
    "Content-Type": "application/json%3Bcharset=UTF-8"
}
  • Response body 
    {
    "mobilePhone": "153****0991",
    "company":"Huawei XXXXXXXXX",
    "customerName":"zXXXXXX",
    "email":"sunk****@huawei.com",
    "vdn":"150",
    "createDate":1681203525000,
    "tenantSpaceStatus":"2",
    "portalUrl":"https://software.huawei.com/auth?client_id=xxxxx&redirect_uri=https://xxx.com/service-cloud/sm/login/portal.html"
}