Retrieves the user with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
userName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier |
Required |
db_language_id |
Foreign key of db_language |
globally unique identifier | |
username |
Username of the user, normally his email address |
string |
Required Max length: 255 |
firstname |
Firstname of the user |
string |
Max length: 255 |
lastname |
Lastname of the user |
string |
Required Max length: 255 |
code |
The Id/Ref of the back office. Used by Embedded entity |
string |
Max length: 50 |
archived |
Archive the user if he is not valid anymore (user cannot be deleted) |
boolean | |
disabled |
Disable temporaly the user (cannot log on) |
boolean | |
emergency_contact |
HR : Person to contact in case of emergency (wife,husband) |
string |
Max length: 64 |
bankaccount |
HR : Bank Account |
string |
Max length: 50 |
social_security |
HR : Social Security Number |
string |
Max length: 50 |
place_of_birth |
HR : place of birth |
string |
Max length: 255 |
nationality |
HR : nationality of the user |
string |
Max length: 255 |
functions |
HR : Functions of the user (Manager, Tech leader) |
string |
Max length: 255 |
birthdate |
HR : Birthdate of the user |
date | |
skype |
Skype name |
string |
Max length: 50 |
notes |
Internal notes/remarks |
string | |
sales_organization_id |
Main organization of the user |
globally unique identifier |
Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided |
sales_organization |
Embedded entity "sales_organization" when adding/updating user |
sales_organization |
Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided |
sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating user |
string |
Optionally required : sales_organization_id, sales_organization_code or sales_organization must be provided |
is_team_leader |
Specify if this user can be used as a team leader |
boolean | |
team_leader_user_id |
Specify his team leader if this user is a team member |
globally unique identifier | |
Email of the user |
string |
Required Max length: 255 |
|
phone |
Phone number of the user |
string |
Max length: 50 |
fax |
Fax number of the user |
string |
Max length: 50 |
mobile |
Mobile number of the user |
string |
Max length: 50 |
private_email |
Private Email of the user |
string |
Max length: 250 |
private_phone |
Private Phone number of the user |
string |
Max length: 50 |
private_fax |
Private Fax number of the user |
string |
Max length: 50 |
private_mobile |
Private Mobile number of the user |
string |
Max length: 50 |
private_street |
Private Address:Street |
string |
Max length: 50 |
private_street_number |
Private Address:Street Number |
string |
Max length: 50 |
private_city |
Private Address:City |
string |
Max length: 50 |
private_zip |
Private Address:Zip |
string |
Max length: 50 |
private_db_country_id |
Private Address:Country |
globally unique identifier | |
private_db_country_code |
Private Address:CountryCode entity using international code when adding/updating user |
string | |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
allow_hero_app |
Specify if this user has priviliages to hero app |
boolean | |
allow_sales_app |
Specify if this user has priviliages to salse app |
boolean | |
allow_service_app |
Specify if this user has priviliages to service app |
boolean | |
user_group_id |
Specify the user group that user belongs to |
globally unique identifier |
Response Formats
application/json, text/json
{ "id": "132305a5-95bb-4f15-bf41-374cfd9418d1", "db_language_id": "f6b4663e-7b60-44d8-b1fb-0c1b4164dffb", "username": "sample string 3", "firstname": "sample string 4", "lastname": "sample string 5", "code": "sample string 6", "archived": true, "disabled": true, "emergency_contact": "sample string 9", "bankaccount": "sample string 10", "social_security": "sample string 11", "place_of_birth": "sample string 12", "nationality": "sample string 13", "functions": "sample string 14", "birthdate": "2025-07-19T00:05:08.5541199+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "30da2fd1-5644-47cf-a07b-44e1f1ba9506", "sales_organization": { "id": "d676bc36-766a-4585-aa9a-cf9431852e4e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "846726bf-23d4-456b-8123-e83e84aef07e", "db_currency_id": "9317c4e2-81ba-496d-80f1-0883370aabe9", "db_language_id": "98ec28c3-31c7-456c-9845-d40885230c59", "accountancy_code": "sample string 8", "archived": true, "default_unit_of_measure_system_type": "sample string 10", "street": "sample string 11", "street2": "sample string 12", "street_number": "sample string 13", "zip": "sample string 14", "city": "sample string 15", "email": "sample string 16", "phone": "sample string 17", "fax": "sample string 18", "url": "sample string 19", "vat_reg_code": "sample string 20", "modified_dateutc": "2025-07-19T00:05:08.5541199+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "605759bb-a692-45e2-bc70-2396961d922b", "email": "sample string 22", "phone": "sample string 23", "fax": "sample string 24", "mobile": "sample string 25", "private_email": "sample string 26", "private_phone": "sample string 27", "private_fax": "sample string 28", "private_mobile": "sample string 29", "private_street": "sample string 30", "private_street_number": "sample string 31", "private_city": "sample string 32", "private_zip": "sample string 33", "private_db_country_id": "6e7c02ab-34e9-4ff7-a6a3-da993bb0b986", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-07-19T00:05:08.5541199+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "40fa6c7e-ecfc-40f6-a360-577e443696e2" }