Skip to main content
Skip table of contents

User commands

CreateUpdateUser

Creates or updates an user in Microbizz.

If a user with the given user id already exists, then the user will be overwritten.

If the user provided have a user id of 0, a new user will be created and a new user id will be provided.

Input

useruserThe user to create/update

Output

useruserThe user object as it is in Microbizz after the update


AddUserToTeam

Add a user to a team, or removes a user from a team.

Can also be used to read which teams the user is member of, by not specifying leader, member or viewer.

Input

useridnumberThe ID of the user
teamidnumberThe ID of the team
leadernumberSet to 1 to mke the user team leader, 0 to remove
membernumberSet to 1 to make the user member of the team, 0 to remove
viewernumberSet to 1 to make the user a team viewer, 0 to remove

Output

teamscollectionA collection with 3 elements: leader, member, viewer which lists the teams for the user

If leader is not set to 0 or 1 or is not specified, then the user's team leadership will not be updated. Likewise for member and viewer.


SetTeamsByUserCode

Set teams by user number.

Set the users association to teams by the users usercode. Existing associations are removed.

Input

usercodestringThe user code of the user
leaderteamscollectionA collection of team IDs where the user is to be team leader
memberteamscollectionA collection of team IDs where the user is to be member
viewerteamscollectionA collection of team IDs where the user is to be viewer

Output

None--


SetMembersByUserCode

Set team members by user code.

Set the team different associated users, by their usercode. Existing associations are removed.

Input

teamidstringA team ID
leaderscollectionA collection of user codes where each user is a team leader
memberscollectionA collection of user codes where each user is a member
viewerscollectionA collection of user codes where each user is a viewer

Output

None--


GetUserByID

Get a user by their Microbizz user id

If no such user exist an empty collection will be returned.

Input

useridnumberThe microbizz user id of the user to fetch

Output

userscollection[ user ]A collection either empty if no user was found, or with exactly one element being the user.


GetUsersByLastChange

Get a collection of users changed since a given date and time.

Input

changedatedateReturn all users changed on or after the provided date.
changetimetimeIf this is provided only return users changed after the provided date and time.
skip_deletedboolIf 1 then don't send deleted users

Output

userscollection[ user ]A collection of the relevant users, or an empty collection if no users was found.


GetTeams

Get all teams in Microbizz, and get “my” teams.

Input

None--

Output

teamscollection[ team ]All teams
myteamscollection[number]The IDs of the teams that the current user belongs to

GetUserTypes

Get all user types in Microbizz

Input

None--

Output

typescollectiontypes
types.idintID of type
types.titlestringTitle
types.letterstringLetter representation
types.colorstringColor code

GetWorkdayByUserID

Get the workday setup for a user

Input

useridnumberThe Microbizz ID of a user

Output

workdayscollection[ number ]

List of workdays where the user is on work

daystartsetThe workday start time for each workday
dayendsetThe workday end time for each workday
daydursetThe workday duration time for each workday

Workdays are numbered from 1 (monday) to 7 (sunday).

GetCompetences

Get all competences defined in Microbizz.

Input

None--

Output

competencescollection[ competence ]All competences

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.