Versions Compared

Old Version 3

changes.mady.by.user Andrew Hill (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.12.0

The User Bulk Import REST API is used to update a collection of mobile technicians in a single API call. The collection can contain any combination of new users, updates to existing users and deleting of users. The CUD Deleted property determines what operation to be performed for the user. 

The valid values for CUD attribute Deleted attribute are:

  • 1 true - The user object should be inserted.deleted2
  • false - The user object should be updated. If the user does not exists it will be added. 3 - The user object should be deleted.

Notes:

  • If the Roles This is the default value if this property is not specified then the current roles will be left unmodified.

Notes:

  • If the Password property is not specified then the current password will be left unmodified 
  • If the RestPassword ResetPassword property is true, then the system will ignore the Password property if provided and automatically generate a new password and email it to the user.Deleting a user that no does not exists will generate a soft warning


Panel
borderColorgrey
bgColorwhitesmoke

Related pages:

 



Resource URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

/seiapi/v3/bulk/Users?customerid=xxxx&customercode=xxxx

Common Parameters

Include Page
_URI Default Parameters
_URI Default Parameters

Supported HTTP Methods

MethodDescription
POSTSubmits a collection of user objects to be added, updated, or deleted.

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Body

The body contains a collection of user objects to be processed. 

Code Block
languagejs
firstline1
titleJSON Format
firstline1
linenumberstrue
{
	"Users" : [
		// Collection of User Objects
	]
}
 

 Include Page
_REST Response Codes
_REST Response Codes