Skip to main content

App Info API

The App Info API provides the endpoints to provide the general app information that may affect the app's in-app navigation.

Endpoints​

# Endpoints
POST
/app/info/versions
# Get app versions
GET
/app/info/init
# Get app initial information
GET
/app/info/default-map-district
# Get default map district
GET
/app/info/default-activity-district
# Get default activity district

Get app versions​

Request (AppVersionReqDTO)​

POST /app/info/versions
{
  "deviceType": 2,
  "deviceToken": "",
  "deviceBrand": ""
}

Response (AppVersionResDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "versions": [
      "1.0.0"
    ],
    "link": "https://www.yahoo.com"
  }
}

Get initial information​

Request​

GET /app/info/init

Response (AppInitInfoDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "setPassword": true,
    "setMascot": false,
    "setDistrict": false
  }
}

Get default map district​

Request​

GET /app/info/default-map-district

Response (AppMapDistrictDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "code": 5
  }
}

Get default activity district​

Request​

GET /app/info/default-activity-district

Response (AppActivityDistrictDTO)​

{
  "success": true,
  "message": "",
  "data": {
    "type": 5
  }
}

Resources​

AppVersionReqDTO​

properties
  • deviceType
    DeviceType
    required
    The device type
  • deviceToken
    string
    The app device token.
  • deviceBrand
    string
    required
    The app device brand.

AppVersionResDTO​

properties
  • versions
    list
    A list of current available versions.
  • link
    string
    The link to download the app.

AppInitInfoDTO​

properties
  • setPassword
    boolean
    It indicates if the user has set password or not.
  • setMascot
    boolean
    It indicates if the user has set mascot or not.
  • setDistrict
    boolean
    It indicates if the user has set district or not.

AppMapDistrictDTO​

properties
  • code
    CommunityEnum
    The enum of the community.

AppActivityDistrictDTO​

properties
  • type
    ActivityDistrictEnum
    The district for article's activity.