Skip to content

Roster Import Fields

The importer accepts Chinese and English header variants that map to:

  • id
  • canonicalName
  • pinyin
  • group
  • active
  • delete
FieldRequiredAccepted valuesNotes
idOptionalPositive integerRequired for updates and deletes.
canonicalNameUsually yesAny non-empty stringMust be unique after normalization.
pinyinOptionalTextAuto-generated when canonicalName changes and pinyin is empty.
groupOptionalTextNormalized by group normalization logic.
activeOptionaltrue/false, yes/no, y/n, 1/0, 是/否, 启用/停用Invalid boolean text causes reject.
deleteOptionaltrue/false, yes/no, y/n, 1/0, 是/否Delete rows must include id.
  • add: creates new roster row.
  • update: updates existing roster row by id.
  • delete: deletes roster row by id.
  • reject: row skipped due to validation error.
  • Duplicate explicit IDs in one import are rejected.
  • Deleting roster rows can cascade delete linked Name Matching rows.
  • Import returns summary counts for add/update/delete/reject.