Add New User in Company API

Require Authentication

This API is used to add new user for the company based on combination of deviceID and token.

Only users that have module "user_and_roles_menu" and "manage_user" in their role/department (currently only Administrator) can add new user

User creation has a limit number of user that can be created, depends on user account type.

URL

api/companies/adduser

Required parameter (POST)

deviceID «contains deviceID of the current logged in user, use for authentication»
token «contains token of the current logged in user, use for authentication»
firstName «contains user first name»
username «contains user email address, must be unique (never register)»
password «contains minimum 5 characters»
retype_password «value must be the same as password»
departmentID «departmentID for this new user. Value must be exist in database. To get the departmentID, please see Get Available Department / Roles»

Optional parameter (POST)

lastName
phone
mobile
active «indicate if user is can login or not. Value must be "Y" or "N". Default value if left empty: "Y"»

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "bb602ab13b8090268cd6e3bb9dfa39e2",
	"username": "test@test.com",
	"password": "passwordtest",
	"retype_password": "passwordtest",
	"firstName": "Test",
	"departmentID": 2,
	"lastName": "API",
	"phone": "1234567890",
	"mobile": "1234567890",
	"active": "Y"
}

Possible return HTTP status code

Return message, contains newly created user profile

{
  "status": "success",
  "message": {
    "profile": {
      "userID": 1006,
      "username": "test@test.com",
      "firstName": "Test",
      "lastName": "API",
      "phone": "1234567890",
      "mobile": "1234567890",
      "profilePicture": "https://dashboard.superfy.com/https://wasteinsights-public-files.s3.ap-southeast-2.amazonaws.com/images/icon_placeholder_logo_individu.jpg",
      "createdDate": 1692256941,
      "active": "Y",
      "timezoneOffset": 0,
      "timezoneName": "",
      "isEmailVerified": "Y",
      "departmentID": 1259,
      "departmentName": "department from api"
    },
    "company": {
      "companyID": 16,
      "companyName": "Smartsensor Live Testing",
      "companyLogoURL": "https://wasteinsights-public-files.s3.ap-southeast-2.amazonaws.com/images/icon_placeholder_logo_company.jpg",
      "companyAddress1": "3/441 Nudgee Road",
      "companyAddress2": "",
      "companyCity": "Hendra",
      "companyState": "QLD",
      "companyCountry": "AU",
      "companyZipCode": "4011",
      "companyLatitude": -27.415924072266,
      "companyLongitude": 153.07464599609,
      "companyPhone": "",
      "companyFax": "",
      "companyWebsite": "",
      "expiredDate": 0,
      "default_currencyCode": "AUD",
      "default_paymentPeriod": "monthly",
      "fillLevelSource": "laseravg",
      "collectionCalculationConfig": "standard",
      "bulkCollectionRadius": "2000",
      "licenseTypeID": 1,
      "licenseTypeName": "Town Plan"
    }
  }
}

Note: "timezoneOffset" contains user time differences to server time in minutes. For example, if it is 420, it means that it is server time +7 hour (420 minutes / 60 minutes × 1 hour = 7 hour)

Superfy Platform API Documentation