Requester Attributes and xml Response

The operations that can be performed on requesters are described below

Note

1. The requester operations that can be performed through API are adding, updating and deleting requester.

2. Technicians with restricted access permission can perform add, edit and delete operations on requesters associated to their sites.

3. The attributes are case sensitive and should be used as defined.

4. When renaming the button in the sample html form, specify 'operation' as hidden element.

Add Requester
Update Requester
Delete Requester

Add Requester

To add a requester, the targetURL attribute should be set to /servlets/RequesterServlet and the 'operation' attribute should be 'AddRequester'. 'account', 'site' and 'name' are mandatory parameters. If 'departmentmentName' parameter is not given, the requester is added to the department 'General'.

Attributes	Comments
targetURL= "/servlets/RequesterServlet"	target url for Adding requester
operation='Addrequester'	operation command for Adding requester
name	Requester name
employeeId	Employee ID of the requester
description	Description about employee
email	Email Address of the requester
phone	Phone Number of the requester
mobile	Mobile number of requester
account	Account to which the requester needs to be associated
site	site to which requester is associated to
departmentName	department name to which the requester is associated to
jobTitle	Job title of the requester.
requestViewPermission	permission for 'Requester allowed to view'. Allowed Values: OWN REQUEST: Requester can see his own requests [default] DEPARTMENT REQUEST: Requester can see all requests that belong to his department SITE REQUEST: Requester can see all requests that belong to his site ACCOUNT REQUEST: Requester can see all requests that belong to his account
approvePurchaseOrder	Purchase Order Approver Allowed Values:true, false.
UDF aliases name	additional fields should be specified based on their column names
loginName	login name
pwd	password
userDomainName	Domain with which the requester is associated to
username	Login Name for ServiceDesk Plus - MSP Authentication
password	Password for ServiceDesk Plus - MSP Authentication
DOMAIN_NAME	Domain Name to which the user belongs
logonDomainName	Authentication Mode [AD or Local Authentication]. �AD_AUTH� refers to Active Directory Authentication. �Local Authentication� or empty value refers to Local Authentication.

Note:

If 'requestViewPermission' value is vacant, then the value is set as 'Show only their request'.
By default, the value for approvePurchase Order is false.
'approvePurchaseOrder' is enabled only when the email ID of the requester is available.

The sample form for adding a new requester can be viewed here.

The html form is submitted to http://machinename:Portnumber/servlets/RequesterServlet and a response in xml format displays Success message along with the userID or Requester ID.

A failure message appears

If the technician adding the requester is not associated to the site and has restricted access permissions.
A technician without administrator privilege is trying to add a requester. [Click here to view the xml response]

Update Requester

To update a requester, the targetURL attribute should be set to /servlets/RequesterServlet and the 'operation' attribute should be 'UpdateRequester'. 'reqUserName', 'reqLoginName', 'reqEmailId', 'account', 'site' and 'userid' are mandatory parameters.

Attributes	Comments
targetURL= "/servlets/requesterServlet"	target url for Updating requester.
operation='Updaterequester'	operation command for Updating requester.
reqUserName	Requester Name to update
reqLoginName	Requester Login Name to update
reqdomainName	Domain Name to which the requester belongs to
reqEmailId	Requester Email-Id to update
userid	Requester Id
name	Requester name
employeeId	Employee ID of the requester
description	Description about employee
email	Email Address of the requester
phone	Phone Number of the requester
mobile	Mobile number of requester
account	Account to which the requester needs to be associated
site	Site to which the requester needs to be associated
departmentName	department name to which the requester is associated to
jobTitle	Job title of the requester
requestViewPermission	permission for 'Requester allowed to view'. Allowed Values: OWN REQUEST: Requester can see his own requests [default] DEPARTMENT REQUEST: Requester can see all requests that belong to his department SITE REQUEST: Requester can see all requests that belong to his site ACCOUNT REQUEST: Requester can see all requests that belong to his account
approvePurchaseOrder	Purchase Order Approver Allowed Values:true,false.
UDF aliases name	additional fields should be specified based on their column names
loginName	login name
pwd	password
userDomainName	Domain with which the requester is associated to
username	Login Name for ServiceDesk Plus - MSP Authentication
password	Password for ServiceDesk Plus - MSP Authentication
DOMAIN_NAME	Domain Name to which the user belongs
logonDomainName	Authentication Mode [AD or Local Authentication]. �AD_AUTH� refers to Active Directory Authentication. �Local Authentication� or empty value refers to Local Authentication.

Note:

While performing the edit operation, requesters are identified based on the order below,

The users are first identified based on the 'reqLoginName' and 'reqDomainName'.
If the 'reqDomainName' is empty, the user is identified based on the 'reqLoginName' with 'reqDomainName' as an empty value.
If the requester does not fall under the above criteria, the user is identified based on the 'reqEmailid'.
If the requester is unavailable in the above specified criteria, the user is identified based on the 'reqUserName'.
If the user cannot be identified from the above criteria, then the user is identified based on 'userid'.
Based on the reqUserName or reqEmailId, if more than one users are identified then the user is not updated nor deleted.

Login information of requesters cannot be edited through API.
To enable 'Purchase Order Approver' role while editing a requester, 'email' should be specified along with 'approvePurchaseOrder' even if 'email' has been configured for the requester.

The sample form to update requester can be accessed here.

The requester details are updated successfully indicated with a Success message in the xml form.

Delete Requester

To delete a requester, the targetURL attribute should be set to /servlets/RequesterServlet and the 'operation' attribute should be 'DeleteRequester'.

Attributes	Comments
targetURL= "/servlets/requesterOperationServlet"	target url for deleting requester
operation='Deleterequesters'	operation command for deleting requester
name	requester Name
loginName	Requester's loginName
domainName	Requester's login domain name
emailId	Requester's emailId
userid	Requester id
username	Login Name for ServiceDesk Plus - MSP Authentication
password	Password for ServiceDesk Plus - MSP Authentication
DOMAIN_NAME	Domain Name to which the user belongs.
logonDomainName	Authentication Mode [AD or Local Authentication]. �AD_AUTH� refers to Active Directory Authentication. �Local Authentication� or empty value refers to Local Authentication.

The sample form to delete requesters can be viewed here.

A Success message appears as the xml response if the technician has permission to delete requesters.