Roster Import Fields
Accepted headers
Section titled “Accepted headers”The importer accepts Chinese and English header variants that map to:
- id
- canonicalName
- pinyin
- group
- active
- delete
Field rules
Section titled “Field rules”| Field | Required | Accepted values | Notes |
|---|---|---|---|
| id | Optional | Positive integer | Required for updates and deletes. |
| canonicalName | Usually yes | Any non-empty string | Must be unique after normalization. |
| pinyin | Optional | Text | Auto-generated when canonicalName changes and pinyin is empty. |
| group | Optional | Text | Normalized by group normalization logic. |
| active | Optional | true/false, yes/no, y/n, 1/0, 是/否, 启用/停用 | Invalid boolean text causes reject. |
| delete | Optional | true/false, yes/no, y/n, 1/0, 是/否 | Delete rows must include id. |
Action outcomes
Section titled “Action outcomes”- 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.
Important behavior
Section titled “Important behavior”- 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.