On This Page:

Related Pages:

The sp:CreateUserRequest API method can be used to add new users to the ServiceScheduling system, as an alternative to the ServiceManager UI for adding users.

Description

Allows new user accounts to be added to ServiceScheduling.

Definition

The definition of this API is:

Web Service			Type	Description	Req?	Val?
`<sp:CreateUserRequest>`
	`<userId>?</userId>`		`string(50)`	A new User ID for the user to be created. The User ID must not already exist in the ServiceOptimizer database.
	`<user>`			Required section containing the details of the new user to be added.
		`<name>?</name>`	`string(50)`	The name of the new user.
		`<enabled>?</enabled>`	`Boolean`	If true, the new user is permitted to use ServiceManager.
		`<profile>?</profile>`	`string(10)`	The user profile for the user to be created. The user profile must exist in the ServiceOptimizer database.
		<authentication>?</authentication>	`AuthType`	Either `INTERNAL` or `LDAP`. If `LDAP`, then the new user's login will be authenticated using the configured external LDAP server; otherwise, authentication will be performed by ServiceScheduling. See `password` below.
		`<password>?</password>`	`string(50)`	The new user's password. Ignored if `authentication` is `LDAP`.
		`<unitType>?</unitType>`	`UserUnitType`	The values can be `ROOT,BRU,DRU` or `FRU`. Defaults to `ROOT` if omitted during creation.
		`<respUnit>?<respUnit>`	`string(8)`	If `unitType` is `ROOT`, `respUnit` must be the top level RU, and will default to this if omitted. If `unitType` is `BRU`, `respUnit` must be an BRU reference. If `unitType` is `DRU`, `respUnit` must be an DRU reference. If `unitType` is `FRU`, `respUnit` must be an FRU reference.
	`</user>`
`</sp:CreateUserRequest>`

Return Structure

The API returns the standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

SP_USERID_EXISTS (702)
SP_PROFILE_DOES_NOT_EXIST (704)
SP_UNIT_REF_INVALID (705)

Browser not supported