Overview
All the API methods available for Users.
All the API methods available for Users.
Table of Contents
- Users
- Overview
- View User
- Edit User
- List Users
- Send Notification
- Add Document to User
- Add Note to User
- List Countries
- View Inventory Transaction
- List Inventory
- List User Schedule
- Add User Group
- View User Address
- View User By ExternalID
- View User Group
- Add/Update User Profile Image
- Add User Training Services
- Edit User Training Services
- Remove User Training Services
Parameters
Allows the API to create and update your users. You can retrieve individual user(s) as well as a list of all users.
Allows the API to create and update your users. You can retrieve individual user(s) as well as a list of all users.
| mobiworkUserId required |
Long An unique ID representing an internal ID |
| externalId optional |
String Represents the third-party clients internal ID |
| firstName required |
String First name of the user |
| lastName required |
String Last name of the user |
| loginId required |
String LoginId of the user |
| email optional |
String Email of the user |
| status required |
Integer Status of the user. User statuses are REGISTRATION_INCOMPLETE(1), ACTIVE(2), DISABLED(3), AWAITING_CONFIRMATION(4) |
| jobTitle optional |
String Job title of the user |
| reportsToName optional |
String Supervisor name of the user |
| phoneNumber optional |
String Phone number of the user |
| altPhoneNumber optional |
String Alternate phone number of the user |
| faxNumber optional |
String Fax number of the user |