Retrieves all users

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

user
NameDescriptionTypeAdditional 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: 50

firstname

Firstname of the user

string

Max length: 50

lastname

Lastname of the user

string

Required

Max length: 50

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

Email of the user

string

Required

Max length: 250

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

Sample:
{
  "id": "660c04a8-8f5f-4947-8f1c-677d7acf3e95",
  "db_language_id": "fdb726b8-4e27-40fd-adb0-beb4d22fdf46",
  "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": "2022-08-17T03:10:58.1495163+02:00",
  "skype": "sample string 16",
  "notes": "sample string 17",
  "sales_organization_id": "0fef7d63-b72b-4dcf-88aa-300fa298d146",
  "sales_organization": {
    "id": "c73b3afe-4b64-4eac-9c1c-953ef39001d4",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "b9e9f984-5b0b-45fb-b548-5b6f1d027a9d",
    "db_currency_id": "e5149a82-c7cb-40b0-9ed4-3099d9de4702",
    "db_language_id": "ae68172a-ec6d-4d79-8483-6fc7b07ecfdd",
    "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": "2022-08-17T03:10:58.1495163+02:00"
  },
  "sales_organization_code": "sample string 19",
  "is_team_leader": true,
  "team_leader_user_id": "9be6f181-8c90-4e70-a8ba-28647c8cff53",
  "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": "504091b7-21d1-4c0f-978c-b7bc63be212d",
  "private_db_country_code": "sample string 35",
  "modified_dateutc": "2022-08-17T03:10:58.1495163+02:00",
  "allow_hero_app": true,
  "allow_sales_app": true,
  "allow_service_app": true,
  "user_group_id": "b2439aec-c691-4fd9-ae67-38d1d9b35e68"
}