/
_API GetUserRequest Response
Document toolboxDocument toolbox

_API GetUserRequest Response

Owned by Matthew Wren (Unlicensed)
Jun 13, 2023
 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>stringThe Return Code name, representing the result of the API call.  
  <code>?</code>intThe 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>