API Description

Updated on 2023-10-12 GMT+08:00

View PDF

Version

V1.0.0

Function

This API is used to query customer information.

Method

The request method must be set to POST. This API supports only POST and does not support PUT, GET, DELETE, or other methods.

URL

Example: /rest/v1/queryCustomer

In the URL, v1 indicates the API version.

Request

Request header

Content-Type:application/json; charset=UTF-8,

Connection:keep-alive

Request body

The following provides an example of the request body of this API:

{
  "param":"152****1028"
 }

Table 1 describes the parameter in the request body of this API.

**Table 1** Request body parameter
Parameter	Type	Mandatory or Not	Description
param	String	Yes	Third-party query parameters.

Response

The following provides an example of the response body of this API:

[
   {
     "objectName": "Customer information",
     "values": [
       {
         "valueNo": "1",
         "length": "128",
         "type": "1",
         "value": "zengxiangyu01",
         "isMandatory": true,
         "name": "Name",
       },
       {
         "valueNo": "2",
         "dictItems": [
           {
             "value": "Prepaid",
             "key": "1"
           },
           {
             "value": "Postpaid",
             "key": "2"
           }
         ],
         "type": "5",
         "value": "1",
         "isMandatory": true,
         "name": "Payment mode",
       }]
   }
 ]

Table 2 describes the parameters in the response body of this API.

**Table 2** Response body parameters
Parameter	Type	Mandatory or Not	Description
objectName	String	Yes	Returned information description.
values	Array	Yes	Returned information values. For details about the parameters, see Table 3.

**Table 3** values parameters
Parameter	Type	Mandatory or Not	Description
valueNo	String	No	Sequence number.
name	String	Yes	Attribute name.
value	Object	Yes	Attribute value.
type	String	Yes	Type. The options are as follows: 1: string 2: number 3: date 4: time 5: data dictionary
length	String	No	Length. The maximum length is 256 characters.
isMandatory	Boolean	Yes	Whether an attribute is mandatory.
maskStyle	String	No	Mask display type. The options are as follows: 1: The last four digits are displayed. 2: The first four digits are displayed. If this parameter is empty or not transferred, all digits are displayed.
dictItems	Array	No	Dictionary items. This parameter is mandatory when type is set to 5. For details about the parameters, see Table 4.