Difference between revisions of "User new"
| Line 1: | Line 1: | ||
{{HelpFiles}} | {{HelpFiles}} | ||
| − | ==== User_new ==== | + | ==== User_new ==== |
Create a new user object | Create a new user object | ||
| Line 18: | Line 18: | ||
An ''array'', it is a user object which contains the following items | An ''array'', it is a user object which contains the following items | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | {| width="875" class="tableintopic" style="border: 1px solid rgb(1, 1, 1); border-collapse: collapse;" border="1" cellspacing="0" cellpadding="2" | |
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#c0c0c0" | | ||
| + | '''Index''' | ||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#c0c0c0" | | ||
| + | '''Data type''' | ||
| − | ''' | + | | width="467" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#c0c0c0" | |
| + | '''Value''' | ||
| − | Version 5.6 __NOTOC__ | + | |- align="left" valign="top" |
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_RESOURCE_ID</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">number</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Resource id</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_NAME</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Username</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_TEMPLATE_RESOURCE_ID</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">number</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">User template's resource id</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_PASSWORD</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Password</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_TIME_REGISTRATION</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">bool</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">If time registration is allowed</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_MAN_HOURS</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">number</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Number of budget hours</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_CALCULATED_MAN_HOURS</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">bool</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">If number of budget hours is calculated on Team tab's settings</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_PHONE_NUMBER</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">array</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Phone number list</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_ACCESS_EXPIRATION</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">aray</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Expiration date</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_PROTECTED_UNTIL</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">array</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Protection deadline</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_LANGUAGE</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Language's ISO code</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_CULTURE</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Culture's ISO code</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_EMAIL</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Email address</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_FIRST_NAME</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">First name</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_MIDDLE_NAME</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Middle name</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_LAST_NAME</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Last name</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_CURRENCY</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Currency</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_DISCOUNT</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Discount</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_POINT_BALANCE</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">number</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Point balance (read-only)</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_TIMEZONE</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">number</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Timezone</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_ADDRESS</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Address</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_CITY</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">City</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_ZIPCODE</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Zip code</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_REGION</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Region</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_COUNTRY</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Country's ISO code</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_POSTBOX</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Postbox</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_WEBSITE</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">string</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">Website</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_DELETED</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">bool</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">If the user is deleted</span> | ||
| + | |||
| + | |- align="left" valign="top" | ||
| + | | width="292" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">USER_DISABLED</span> | ||
| + | |||
| + | | width="116" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">bool</span> | ||
| + | |||
| + | | width="467" style="border: 1px solid rgb(1, 1, 1);" | | ||
| + | <span class="normalise">If the user is disabled</span> | ||
| + | |||
| + | |} | ||
| + | |||
| + | <br> '''Availability''' | ||
| + | |||
| + | Version 5.6 __NOTOC__ | ||
[[Category:User_Functions]] | [[Category:User_Functions]] | ||
Revision as of 07:02, 19 December 2011
User_new
Create a new user object
Syntax
User_new(username, password, userTemplateResourceId)
Arguments
- username: is a string expression. It is the user's username, it must follow the common format of usernames
- password: is a string expression. It is the user's password, it must follow the common format for passwords
- userTemplateResourceId: is a number expression. It is the user template's resource id
Return value
An array, it is a user object which contains the following items
|
Index |
Data type |
Value |
|
USER_RESOURCE_ID |
number |
Resource id |
|
USER_NAME |
string |
Username |
|
USER_TEMPLATE_RESOURCE_ID |
number |
User template's resource id |
|
USER_PASSWORD |
string |
Password |
|
USER_TIME_REGISTRATION |
bool |
If time registration is allowed |
|
USER_MAN_HOURS |
number |
Number of budget hours |
|
USER_CALCULATED_MAN_HOURS |
bool |
If number of budget hours is calculated on Team tab's settings |
|
USER_PHONE_NUMBER |
array |
Phone number list |
|
USER_ACCESS_EXPIRATION |
aray |
Expiration date |
|
USER_PROTECTED_UNTIL |
array |
Protection deadline |
|
USER_LANGUAGE |
string |
Language's ISO code |
|
USER_CULTURE |
string |
Culture's ISO code |
|
USER_EMAIL |
string |
Email address |
|
USER_FIRST_NAME |
string |
First name |
|
USER_MIDDLE_NAME |
string |
Middle name |
|
USER_LAST_NAME |
string |
Last name |
|
USER_CURRENCY |
string |
Currency |
|
USER_DISCOUNT |
string |
Discount |
|
USER_POINT_BALANCE |
number |
Point balance (read-only) |
|
USER_TIMEZONE |
number |
Timezone |
|
USER_ADDRESS |
string |
Address |
|
USER_CITY |
string |
City |
|
USER_ZIPCODE |
string |
Zip code |
|
USER_REGION |
string |
Region |
|
USER_COUNTRY |
string |
Country's ISO code |
|
USER_POSTBOX |
string |
Postbox |
|
USER_WEBSITE |
string |
Website |
|
USER_DELETED |
bool |
If the user is deleted |
|
USER_DISABLED |
bool |
If the user is disabled |
Availability
Version 5.6
