Content Ability Development Guide

1. Content Data Access Interface Specifications

Huawei uses a service aggregation gateway to periodically call the developer server interfaces to obtain content data and save the data to the database. In addition, Huawei provides interfaces for developer servers to call for real-time content data synchronizationPerformance Requirements

2. Developer Content Data Access

Before importing content data, check the total data volume and daily data change volume by using the following checklist.

3. Security Requirements

3.1 Interface Protocol and Header Fields

Interface protocol: HTTPS
HTTPS certificate: Use a certificate issued by a valid CA. A self-signed certificate is not allowed.
Data format: Both the request and response are in JSON format.
Request method: POST
Packet compression: Responses must be compressed in GZ format to reduce bandwidth consumption.
Persistent connection: HTTP keep-alive is supported to avoid repeated TLS connection establishment. Huawei servers use persistent connections to call interfaces.
The following is an example of a request header:
POST / HTTP/1.1
Content-Type : application/json;charset=UTF-8
Host : your.host.of.api
Accept : application/json
Accept-Charset : utf-8
Content-Length : 1024

4. Result Codes

4.1 Service Result Code Definition

Definition of ContentTypeId

5. Sports Event Interface List

5.1 Server URL

＜/＞

5.2 Interface for Obtaining Team Information

5.2.1 Basic Information

Method: POST
URL: /sports/teams
Function: To obtain the information about sports teams.

5.2.2 Request Header

None

5.2.3 Request Message

Name: requestBody
Mandatory: Yes
Type: SportsTeamInfoReq
Description: Request message.

5.2.4 Response Message

1． Status code: 200
Response body type: SportsTeamInfoRsp
Description: The query is successful and the query result is returned.

5.3 Interface for Obtaining Sports League Information

5.3.1 Basic Information

Method: POST
URL: /sports/leagues
Function: To obtain information about sports leagues.

5.3.2 Request Header

None

5.3.3 Request Message

Name: requestBody
Mandatory: Yes
Type: SportsLeagueInfoReq
Description: Request message.

5.3.4 Response Message

1.　Status code: 200
Response body type: SportsLeagueInfoRsp
Description: The query is successful and the query result is returned.

5.4 Interface for Obtaining Sports Schedule Information

5.4.1 Basic Information

Method: POST
URL: /sports/schedules
Function: To obtain information about sports schedules.

5.4.2 Request Header

None

5.4.3 Request Message

Name: requestBody
Mandatory: Yes
Type: SportsScheduleInfo
Description: Request message.

5.4.4 Response Message

1.　Status code: 200
Response body type: SportsScheduleInfoRsp
Description: The query is successful and the query result is returned.

5.5 Basic Type Structure

5.5.1 LeagueId

League ID, which is NBA (NBA), UK_EPL (Premier League), ITA_SERIEA (Serie A), ESP_LALIGA (La Liga), GEM_BUNDESLIGA (Bundesliga), FRA_L1 (Ligue 1), CN_CBA (CBA), or CN_CSL (Chinese Super League).

5.5.2 DateTimeFormatString

Time format: yyyyMMddHHmmss

5.5.3 DateFormatString

Date format: yyyy-HH-dd

5.6 Object Type Structure

5.6.1 SportsTeamInfoReq

Query by league ID list.

5.6.2 SportsTeamInfoRsp

5.6.3 SportsLeagueInfoReq

Query by league ID list.
No parameter.

5.6.4 SportsLeagueInfoRsp

5.6.5 SportsTeamInfoItem

5.6.6 SportsLeagueInfoItem

5.6.7 SportsScheduleInfo

The query modes of the SportsScheduleInfo request are as follows: (1) Query of league schedules by league ID, start date, and end date. (2) Query of all known league schedules in a specified period by start date and end date.

5.6.8 SportsScheduleInfoRsp

5.6.9 SportsScheduleInfoItem

5.6.10 SportsScheduleInformationItem

Information about the competition.

5.6.11 SportsScheduleTeam

Team information.

5.6.12 Interaction

5.6.13 NativeAppLinkInteraction

Redirect to a native app.

5.6.14 QuickAppLinkInteraction

Redirect to a Quick app.

5.6.15 Image

Single image information.

5.6.16 ImageInfo

Image information. At least one image must be provided.

6 Weather Interface List

API key weather Info is used for providing ready access to weather information.

6.1 Request

The following describes the request for weather information.

1. Scenario A: In the case where the user does not enter the location and time, HAG invokes CP using the longitude and latitude of the user device and the time on the server. Each of the longitude, the latitude, and the time on the server is passed by using a separate field in the request body instead of a slot.

2. Scenario B: HAG invokes CP by using IP address of the endpoint and the time on the server. The IP address is passed using a slot. The time on the server is passed using a separate field in the request body.

3. Scenario C: In the case where the user queries about weather with speech input identifying the name of a city, the name of either a county or a district in the city, or a combination of any of the names, HAG invokes CP using the user provided name or names plus the time on the server. Names of the city and district/county are passed using slots.
   a. If the user queries about weather in Nanjing, the parameters to be used are city name and time on the server.
   b. If the user queries about weather in Yuhuatai District of Nanjing, the parameters to be used are city name, district name, and time on the server.
   c. If the user queries about weather in Jiangning County of Nanjing, the parameters to be used are city name, county name, and time on the server.
   d. If the user queries about weather in Yuhuatai District/Jiangning County, the parameters to be used are district/county name and time on the server.

Constraint 1: A city name may be one of a city outside China, for example London.

Constraint 2: Compatibility is required among names of the parameters. Full style consistency is not required for the names.

Example Request Message:

{
        "slots": {
          "ip": {
            "name": "ip",
            "slotType": "string",
            "values": [
              {"real":"10.10.10.10"}
            ]
          },
          "city": {
            "name": "city",
            "slotType": "string",
            "values": [
              {"real":"Nanjing"}
            ]
          },
           "district": {
            "name": "district",
            "slotType": "string",
            "values": [
              {"real":"Yuhuatai District"}
            ]
          },
           "county": {
            "name": "county",
            "slotType": "string",
            "values": [
              {"real":"Jiangning County"}
            ]
          }
        }
      }

6.2 Response

The following describes the response that delivers the weather information.
Example Response Message:

{
          "items":[{
              "aqi":{
                  "co":7,
                  "no2":23,
                  "o3":10,
                  "pm10":52, 
                  "pm25":104,
                  "so2":7,
                  "aqivalue":137,
                  "aqivalueText":"good",
                  "aqidesc":"The air is fresh. It is good to go for a walk outside."
              },
              "city":{
                  "name":"Nanjing",
                  "timezone":"Asia/shanghai",
                  "provicename":"Jiangsu Province",
                  "countryname":"China"
              },
              "condition":{
                  "weatherid":21,
                  "cnweatherid":21,
                  "humidity":"60",
                  "temperature":25,
                  "realfeel":20,
                  "winddir":"NW",
                  "windspeed":3,
                  "updatetime":1547119922807,
                  "pressure":1020 ,
                  "uVIndex":1,
                  "uVIndexText":"weak",
                  "mobileLink":{
                      "webURL":"webURL",
                      "deepLink":{
                          "url":"",
                          "appName":"appName",
                          "appPackage":"appPackage",
                          "minVersion":1.0,
                          "minAndroidAPILevel":1.0
                      },
                      "quickApp":{
                          "url":"url",
                          "minPlatformVersion":1.0,                    
                          "minVersion":1.0
                      }
                  }                  
              },
              "dailys":{                             
                  "dailyweathers":[
                      {
                          "moonphase":"WaxingGibbous",
                          "moonRise":1547119922807, 
                          "moonSet":1547119922807,
                          "sunRise":1547119922807,
                          "sunSet":1547119922807,
                          "maxTemp":27,
                          "minTemp":17, 
                          "conditionDay":{
                              "weatherid":21,
                              "cnweatherid":21,
                              "winddir":"E",
                              "windlevel":2, 
                              "windspeed":3
                          },
                          "conditionNight":{
                              "weatherid":21,
                              "cnweatherid":21,
                              "winddir":"NW",
                              "windlevel":2,
                              "windspeed":3
                          },
                          "publicTime":1547119922807,
                          "sources":[""]
                      }
                  ],
                  "publictime":1547119922807,
                  "mobileLink":{
                      "webURL":"webURL",
                      "deepLink":{
                          "url":"",
                          "appName":"appName",
                          "appPackage":"appPackage",
                          "minVersion":1.0,
                          "minAndroidAPILevel":1.0
                      },
                      "quickApp":{
                          "url":"url",
                          "minPlatformVersion":1.0,                    
                          "minVersion":1.0
                      }
                  }                             
              }, 
              "hourlys":{
                  "hourlyweathers": [{
                          "weatherid":21, 
                          "cnweatherid":21,
                          "Isdaynight":false,
                          "rainProbability":30,
                          "date":1547119922807,
                          "temp":27
                  }],
                  "mobileLink":{
                      "webURL":"webURL",
                      "deepLink":{
                          "url":"",
                          "appName":"appName",
                          "appPackage":"appPackage",
                          "minVersion":1.0,
                          "minAndroidAPILevel":1.0
                      },
                      "quickApp":{
                          "url":"url",
                          "minPlatformVersion":1.0,                    
                          "minVersion":1.0
                      }
                  }     
              },
              "liveInfos": [{
                  "code": "1",
                  "level": 2,
                  "name": "dressing index",
                  "updatetime": 1550490100768,
                  "day": "2019-02-18",
                  "content": "woolen sweater or  thick coat" ,
                  "status": "cold"
                }, {
                  "code": "2",
                  "level": 3,
                  "name": "sports index",
                  "updatetime": 1550490100765,
                  "day": "2019-02-18",
                  "content": "",
                  "status": "unfavorable"
                }, {
                  "code": "3",
                  "level": 3,
                  "name": "cold index",
                  "updatetime": 1550490100762,
                  "day": "2019-02-18",
                  "content": "",
                  "status": "easy to catch cold"
                }, {
                  "code": "4",
                  "level": 1,
                  "name": "car wash index",
                  "updatetime": 1550490100764,
                  "day": "2019-02-18",
                  "content": "",
                  "status": "favorable"
                }, {
                  "code": "5",
                  "level": 1,
                  "name": "travel index",
                  "updatetime": 1550490100762,
                  "day": "2019-02-18",
                  "content": "",
                  "status": "unfavorable"
                }, {
                  "code": "6",
                  "level": 1,
                  "name": "UV index",
                  "updatetime": 1550490100764,
                  "day": "2019-02-18",
                  "content": "",
                  "status": "weakest UV light"
                }],
              "alert":{
                  "title":"title",
                  "content":"main body",
                  "level":2,
                  "LevelName":"yellow",
                  "publicTime":1547119922807,
                  "type":1,
                  "typeName":"typhoon"
              }
          }]
      }

6.3 Structure

6.3.1 WeatherInfoDetail

Structure of WeatherInfoDetail is shown in the following table.

6.3.2 WeatherAqi

WeatherAqi delivers information on the air quality index.
Structure of WeatherAqi is shown in the following table.

6.3.3 WeatherCity

WeatherCity delivers information on the city, including the time zone of the city or area.

6.3.4 CnWeatheridDef

CnWeatheridDef delivers the weather ID, with the values explained below:
00: Sunny
01: Cloudy
02: Overcast
03: Shower
04: Thundershower
05: Thundershower with hail
06: Sleet
07: Light rain
08: Moderate rain
09: Heavy rain
10: Storm
11: Heavy storm
12: Severe storm
13: Snow flurry
14: Light snow
15: Moderate snow
16: Heavy snow
17: Snowstorm
18: Foggy
19: Ice rain
20: Duststorm
21: Light to moderate rain
22: Moderate to heavy rain
23: Heavy rain to storm
24: Storm to heavy storm
25: Heavy to severe storm
26: Light to moderate snow
27: Moderate to heavy snow
28: Heavy snow to snowstorm
29: Dust
30: Sand
31: Sandstorm
53: Haze
99: Unknown
Structure of CnWeatheridDef is shown in the following table.

6.3.5 WinddirDef

WinddirDef delivers the wind direction.
Structure of WinddirDef is shown in the following table.

6.3.6 WeatherCondition

WeatherCondition delivers real-time information on current weather.

6.3.7 Dailys

Dailys delivers weather data of the eight days starting from yesterday, to be returned in the order of time.
Structure of Dailys is shown in the following table.

6.3.8 DayWeatherInfo

DayWeatherInfo delivers information on daily weather.
Structure of DayWeatherInfo is shown in the following table.

6.3.9 DayNightCondition

DayNightCondition delivers information on daytime and night weather.

6.3.10 Hourlys

Hourlys delivers information on weather in the next 24 hours starting from the current hour, to be returned in the order of time.
Structure of Hourlys is shown in the following table.

6.3.11 DressingIdxDef

DressingIdxDef delivers the dressing index, with the value explained below:

• 1: down coat - frigid.
• 2: thick coat - cold.
• 3: sweater - cool.
• 4: thin coat - slightly cozy.
• 5: long-sleeved clothes - cozy.
• 6: short-sleeved clothes - hot.
• 7: short-sleeved clothes - scorching.

Structure of DressingIdxDef is shown in the following table.

6.3.12 SportsIdxDef

SportsIdxDef delivers the sports index, with the values explained below:

• 1: favorable for sports
• 2: slightly favorable for sports
• 3: not favorable for sports
  Structure of SportsIdxDef is shown in the following table.

6.3.13 ColdIdxDef

ColdIdxDef delivers the cold index.

• 1: little chance to catch cold
• 2: slightly easy to catch cold
• 3: easy to catch cold
• 4: very easy to catch cold
  Structure of ColdIdxDef is shown in the following table.

6.3.14 CarWashIdxDef

CarWashIdxDef delivers the car wash index.

• 1: not favorable
• 2: slightly unfavorable
• 3: slightly favorable
• 4: favorable

Structure of CarWashIdxDef is shown in the following table.

6.3.15 TourismIdxDef

TourismIdxDef delivers the tourism index.

• 1: not favorable
• 2: slightly unfavorable
• 3: slightly favorable
• 4: favorable

Structure of TourismIdxDef is shown in the following table.

6.3.16 UVIdxDef

UVIdxDef delivers the UV index.

• 1: weakest UV light
• 2: weak UV light
• 3: moderate UV light
• 4: strong UV light
• 5: very strong UV light

Structure of UVIdxDef is shown in the following table.

6.3.17 WeatherLiveInfo

WeatherLiveInfo delivers information provided for daily life based on the weather condition.
Structure of WeatherLiveInfo f is shown in the following table.

6.3.18 WeatherAlertInfo

WeatherAlertInfo delivers information on weather alerts.
Structure of WeatherAlertInfo is shown in the following table.