The attributes to send to the User Creation API — which are mandatory, which are optional, and how the requirements change with userLevel and locationType.
For the full technical REST API reference, see docs.franconnect.net. This guide covers the account-creation payload only.
Core identity fields
These are mandatory for every user type and must appear in every payload.
| Field | Purpose |
|---|---|
<userID> |
Unique identifier (login ID / username) |
<password> |
Login password |
<userLevel> |
Hierarchy level — varies per user type |
<timezone> |
Preferred time zone |
<role> |
Role(s) assigned to the user |
<firstname> <lastname>
|
User's name |
<city> <state>
|
Location |
<phone1> <email>
|
Contact details |
Account behaviour controls
Optional, but check whether your use case needs them.
| Field | Values and dependencies |
|---|---|
<type> |
Normal (default) or Guest. Guest requires <expirationTime>, which expires the account automatically — useful for auditors, trainees and vendors. |
<wmAccess> |
N (default) or Y for World Manager training access. Y requires <wmAccountGroup>, <wmCountry> and <wmEmployeeType>. |
Requirements per user type
| User type | <userLevel> |
Additional mandatory fields |
|---|---|---|
| Corporate | Corporate |
None — typically HQ users, no hierarchy mapping needed |
| Divisional | Divisional |
<division> |
| Regional | Regional |
<region> |
| Franchise |
Employee or Owner
|
<locationType> and <userType> — see below |
Franchise users in detail
<locationType> |
Also requires |
|---|---|
Franchise |
<franchiseeReferenceId> (franchise name / reference ID) or <franchiseeNo> (franchise number) |
MUID |
<muidValue> |
Entity |
<entityName> |
<userType> is New to create a new account or Existing to link to an existing record. Optionally set <canAddEmployee> to Y to let the user create other users (default N).
With Existing — especially when <userLevel> is Owner — a valid owner record must already exist and identifiers must match exactly, or you'll get duplication and mismatch errors.
Field order matters
Send the elements in the exact order below. This is the Corporate sequence; the other user types are identical apart from the hierarchy fields noted underneath.
userID, password, userLevel, userLanguage, timezone, type, expirationTime, role, jobTitle, firstname, lastname, isAuditor, address, city, state, zipCode, country, phone1, phoneExt1, phone2, phoneExt2, fax, mobile, email, sendNotification, loginUserIp, isDaylight, wmAccess, wmAccountGroup, comments
| User type | Differences from the order above |
|---|---|
| Divisional |
division inserted after expirationTime
|
| Regional |
region inserted after expirationTime; wmCountry added after wmAccountGroup
|
| Franchise | After expirationTime: locationType, franchiseeReferenceId, franchiseeNo, muidValue, userType, canAddEmployee. Also supports salutation and birthDate (dd/MMM); adds wmCountry and wmEmployeeType (Full Time, Part Time or Casual). No isAuditor. |
userLanguage defaults to English (Australia). expirationTime accepts 7, 14, 21 or 28 and does not apply to Normal users.
Common mistakes to avoid
Wrong element order — the most frequent cause of failures. Missing dependent fields — wmAccess=Y without the WM attributes, or locationType without its mapping field. Mismatched user level — Divisional needs division, Regional needs region. Guest without expirationTime. Existing record mismatch — check spelling and identifiers exactly.
Need more help
For further assistance with the REST API, contact helpdesk@franconnect.com.