EdData
A A A+ A++

FAQ

About Data

  • What is the standardised format of student data?

Ans: EdCity invited industry partners to share their views on ‘Student Data Standard’, and the 14 data fields include:

  • Mandatory Data (2 fields)
  1. DISPLAY_NAME (Display Name 顯示名稱)
  2. PROFILE_ID (Profile ID 用戶帳戶號碼)
  • Optional Data (12 fields)
  1. HKEDCITY_ID (EdCity Login Name 教城登入帳號)
  2. SCHOOL_CODE (School Reg Number 學校註冊編號)
  3. STUDENT_ENNAME (Student English Name 學生英文姓名)
  4. STUDENT_CHNAME (Student Chinese Name 學生中文姓名)
  5. REG_NO (Student Reg No. 學生註冊編號)
  6. SCH_YEAR (School Year 學年)
  7. CLASS_LVL (Class Level 級別)
  8. CLASS_NAME (Class Name 班別)
  9. CLASS_NUMBER (Class No. 班號)
  10. *GENDER (Sex 性別)
  11. *MOBILE_NO (Mobile Phone No. 流動電話)
  12. *EMAIL (School Email 學校電郵)

* Service provider MUST give a reason for accessing such sensitive data

About Account

  • Are teachers required to handle the data access request via EdData on their own?

Ans: No. The request(s) can be handled by the school administrator who manages EdCity accounts. 

  • Can teachers and students use their Google account to log in to the eResource platforms if the school is using Google Classroom?

Ans: Yes. Simply log in to the platform and follow the steps to enable ‘log in with third party account’ under ‘Setting’. If school intends to connect third party accounts by batch, please contact EdCity for assistance.

  • Can teachers and students log in to the eResource platform by using the email account provided by school?

Ans: Yes. Teachers and students can use the email account provided by school to log in if the school administrator has filled out such information in the ‘School Email’ column.

  • How do schools notify the providers if there are changes made on student data, e.g. adding or removing student account?

Ans: School administrator can update student data on ‘School Accounts Administration System’, providers will then receive an email notification and the update(s) can also be viewed on provider’s admin page of the EdData portal.

About Usage

  • How can school know if a provider has requested for data access?

Ans: School administrator will receive an email notification and the request(s) can also be viewed on administrator’s admin page of the EdData portal.

  • Can school decide whether to authorise or edit providers’ data access request?

Ans: Yes. Except the mandatory data, school can edit or decline providers’ request for accessing the optional data. The system will base on schools’ respond, and notify the provider by email, as well as message on provider’s admin page accordingly.

  • Can school edit the data which provider has been authorised to download?

Ans: Yes. School can edit the data through the EdData portal. The system will notify the provider for such changes. Provider simply downloads then uploads data to the eLearning platform again for the updates. 

About Data

  • What is the standardised format of student data?

Ans: EdCity invited industry partners to share their views on ‘Student Data Standard’, and the 14 data fields include:

  • Mandatory Data (2 fields)
  1. DISPLAY_NAME (Display Name 顯示名稱)
  2. PROFILE_ID (Profile ID 用戶帳戶號碼)
  • Optional Data (12 fields)
  1. HKEDCITY_ID (EdCity Login Name 教城登入帳號)
  2. SCHOOL_CODE (School Reg Number 學校註冊編號)
  3. STUDENT_ENNAME (Student English Name 學生英文姓名)
  4. STUDENT_CHNAME (Student Chinese Name 學生中文姓名)
  5. REG_NO (Student Reg No. 學生註冊編號)
  6. SCH_YEAR (School Year 學年)
  7. CLASS_LVL (Class Level 級別)
  8. CLASS_NAME (Class Name 班別)
  9. CLASS_NUMBER (Class No. 班號)
  10. *GENDER (Sex 性別)
  11. *MOBILE_NO (Mobile Phone No. 流動電話)
  12. *EMAIL (School Email 學校電郵)

* Service provider MUST give a reason for accessing such sensitive data

About Usage

  • Can providers use EdData only, but not EdConnect?

Ans: No. The prerequisite for prroviders to access data via EdData is to use the ‘EdConnect Single Sign-on Directory Service’. If providers are looking for a single sign-on solution, and not required to access school data, they may just apply for the ‘EdConnect Single Sign-on Directory Service’.

  • By using EdData, are providers required to collect data file from schools?

Ans: No. Provider can make request(s) and access data with schools’ authorisation on the EdData portal, provided that the school administrator has updated account information on ‘School Accounts Administration System’.

  • How do providers know if school has responded to the request(s)?

Provider will be notified by email with schools’ responses, including the authorisation, changes request and declination. The information can also be viewed on provider’s admin page of the EdData portal.  

  • How do providers know if school has made changes on student account?

Ans: Provider will be notified by email if school administrator has updated student account on ‘School Accounts Administration System’. The information can also be viewed on provider’s admin page of the EdData portal.

  • How do providers access data?

Ans: Providers can access data by the following ways:

  • Access student data by using the EdData API on the backend
  • Log in to the EdData Portal, and download the encrypted CSV or JSON files