User

Create user

Creates new user.

• POST
• /orgstruct/users

Request body:

Attribute	Type	Description	Nullable
externalId	String	User external id	true
login	String	User login (used to log in to the system)	false
password	String	User password	false
ldapLogin	String	User ldap login	true
email	String	User email	true
firstName	String	User first name	true
lastName	String	User last name	true
position	String	User position	true
authType	Enum of (LOCAL,LDAP)	Authorization type (Local - by password, LDAP - via LDAP authorization)	false
level	Enum of (COMPANY, DIVISION, REGION, SHOP)	User orgstruct level	false
active	Boolean	user activity field	false
supervisor	Boolean	User has role Supervisor	false
admin	Boolean	User has role admin	false
surveyAdmin	Boolean	User has role survey admin	false
taskManager	Boolean	Deprecated	false
userChecklistsOrganizer	Boolean	User can planning checklist to the users	false
shopDirector	Boolean	User has role director of shop	false
canEditAllProcesses	Boolean	User has role can edit all processes	false
canViewAllProcesses	Boolean	User has role can view all processes	false
canEditAllChlTemplates	Boolean	User has role can edit all checklist templates	false
canEditSelectedChlTemplates	Boolean	User has role can edit selected checklist templates	false
lang	Enum of (ru_RU,en_EN)	User language code	false
businessDirId	Integer	User business direction id	false
divisionIds	List of integers	User divisionIds must be not null, if user orgstruct level = Division	true
regionIds	List of integers	User regionIds must be not null, if user orgstruct level = REGION	true
shopIds	List of integers	User shopIds must be not null, if user orgstruct level = SHOP	true
divisionExternalIds	List of string	User external divisionIds	true
regionExternalIds	List of string	User external region Ids	true
shopExternalIds	List of string	User external shop Ids	true
businessDirExternalId	String	User external businessDir id	true
timeZoneId	String	User time zone id format like (Europe/Moscow)	true

Response

Returns User object

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/users \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"login":"samplemail@example.com","email":"samplemail@example.com","firstName":"John","lastName":"Doe","position":"Test position","password":"wrs1234","authType":"LOCAL","level":"COMPANY","active":true,"supervisor":true,"admin":false,"taskManager":false,"userChecklistsOrganizer":false,"shopDirector":false,"shopIds":[],"lang":"ru_RU","businessDirId":1002}'

200 OK

{

"id": 1615,

"active": true,

"login": "samplemail@example.com",

"firstName": "John",

"lastName": "Doe",

"position": "Test position",

"email": "samplemail@example.com",

"level": "COMPANY",

"businessDirId": 1002,

"lang": "ru_RU"

}

Update user

Update existing user by id.

• PUT
• /orgstruct/users/{userId}

Request body:

Attribute	Type	Description	Nullable
login	String	User login (used to log in to the system)	false
password	String	User password	false
ldapLogin	String	User ldap login	true
email	String	User email	true
firstName	String	User first name	true
lastName	String	User last name	true
position	String	User position	true
authType	Enum of (LOCAL,LDAP)	Authorization type (Local - by password, LDAP - via LDAP authorization)	false
level	Enum of (COMPANY, DIVISION, REGION, SHOP)	User orgstruct level	false
active	Boolean	user activity field	false
supervisor	Boolean	User has role Supervisor	false
admin	Boolean	User has role admin	false
surveyAdmin	Boolean	User has role survey admin	false
taskManager	Boolean	Deprecated	false
userChecklistsOrganizer	Boolean	User can planning checklist to the users	false
shopDirector	Boolean	User has role director of shop	false
lang	Enum of (ru_RU,en_EN)	User language code	false
businessDirId	Integer	User business direction id	false
divisionIds	List of integers	User divisionIds must be not null, if user orgstruct level = Division	true
regionIds	List of integers	User regionIds must be not null, if user orgstruct level = REGION	true
shopIds	List of integers	User shopIds must be not null, if user orgstruct level = SHOP	true
divisionExternalIds	List of string	User external divisionIds	true
regionExternalIds	List of string	User external region Ids	true
shopExternalIds	List of string	User external shop Ids	true
businessDirExternalId	String	User external businessDir id	true
timeZoneId	String	User time zone id format like (Europe/Moscow)	true
canEditAllProcesses	Boolean	User has role can edit all processes	false
canViewAllProcesses	Boolean	User has role can view all processes	false
canEditAllChlTemplates	Boolean	User has role can edit all checklist templates	false
canEditSelectedChlTemplates	Boolean	User has role can edit selected checklist templates	false

Response

Returns User object

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/users/userId \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"login":"samplemail@example.com","email":"samplemail@example.com","firstName":"John","lastName":"Doe","position":"Update test position","active":true,"authType":"LOCAL","lang":"ru_RU","surveyAdmin":false,"admin":false,"level":"COMPANY","businessDirId":1002,"supervisor":true,"taskManager":false,"userChecklistsOrganizer":false,"shopDirector":false}'

200 OK

{

"id": 1615,

"active": true,

"login": "samplemail@example.com",

"firstName": "John",

"lastName": "Doe",

"position": "Update test position",

"email": "samplemail@example.com",

"level": "COMPANY",

"businessDirId": 1002,

"lang": "en_EN"

}

List users

Returns a list of User objects

Available fields to add in object see here

• GET
• /orgstruct/users

Request parameters:

Request Parameter	Type	Description	Required
fields	List of String (comma-separated)	Add additional fields to response object	false
active	Boolean	Return only active users	false
ids	List of integers	Find users by ids	false
role	String	Find users by role	false
roles	List of string (comma-separated)	Find users by roles	false
businessDirId	List of integer (comma-separated)	Find users by business directions ids	false
divisionId	Integer	Find users by division id	false
regionId	Integer	Find users by region id	false
login	List of string (comma-separated)	Find users by logins	false
emails	List of string (comma-separated)	Find users by emails	false
levels	Enum set of (COMPANY, DIVISION, REGION, SHOP)	Find users by orgstructure levels	false
directorForShop	Integer	Find users by shop id	false
loginLike	String	Find users by login like	false
emailLike	String	Find users by email like	false
firstNameLike	String	Find users by first name like	false
lastNameLike	String	Find users by last name like	false
positionLike	String	Find users by position like	false

Examples

curl https://api.qvalon.com/v1/orgstruct/users \

--header 'Authorization: Bearer <your_token>'

200 OK

[

{

"id": 1615,

"active": true,

"login": "samplemail@example.com",

"firstName": "John",

"lastName": "Doe",

"position": "Update test position",

"email": "samplemail@example.com",

"level": "COMPANY",

"businessDirId": 1002,

"lang": "en_EN"

}

]

Get user by id

Return User object

Available fields to add in object see here

• GET
• /orgstruct/users/{id}

Request parameters:

Request Parameter	Type	Description	Required
fields	List of String (comma-separated)	Add additional fields to response object	false

Examples

curl https://api.qvalon.com/v1/orgstruct/users/1615 \

--header 'Authorization: Bearer <your_token>'

200 OK

{

"id": 1615,

"active": true,

"login": "samplemail@example.com",

"firstName": "John",

"lastName": "Doe",

"position": "Update test position",

"email": "samplemail@example.com",

"level": "COMPANY",

"businessDirId": 1002,

"lang": "en_EN"

}