On This Page:

Related Pages:

The sp:GetUserRequest API method can be used to get user account details in the ServiceScheduling system, as an alternative to viewing the details in the ServiceManager UI.

Description

Allows user account details in ServiceScheduling to be retrieved.

Definition

The definition of this API is:

Click here to expand...

Web Service		Type	Description	Req?	Val?
`<sp:GetUserRequest>`
	`<userId>?</userId>`	`string(50)`	The User ID for the user to be obtained. The User ID must already exist in the ServiceOptimizer database.
`</sp:GetUserRequest>`

Return Structure

The API returns a non-standard return structure.

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<sp:GetUserResponse>`
	`<result>`			A structure containing details of the success or failure of the API call.
		`<type>?</type>`	`string`	The Return Code name, representing the result of the API call.
		`<code>?</code>`	`int`	The Return Code number, representing the result of the API call.
	`</result>`
	`<name>?</name>`		`string(50)`	The `USER_NAME` column value of table `SP085` - usually the name and surname of the user. This field is only returned when the API call does not return an error Return Code.
	`<enabled>?</enabled>`		`Boolean`	The `ENABLED` column value of table `SP085`, indicating if the user is permitted to use ServiceManager or not. This field is only returned when the API call does not return an error Return Code.
	`<profile>?</profile>`		`string(10)`	The `PROFILE` column value of table `SP085`, being one of the codes defined in the `PROFILE` column of the `SP084` table: `DEPOT`: Team `FINAL`: Final Responsbility Unit `INTERIM`: Interim Responsiblity Unit `READONLY`: Ready Only Gantt `SYSTEM`: ServicePower System Administrator This field is only returned when the API call does not return an error Return Code.
`</sp:GetUserResponse>`

Return Codes

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

SP_USERID_DOES_NOT_EXIST (703)

Browser not supported