Requester Attributes and xml Response

 

The requester attributes along with their actions are given 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. While renaming the button in the sample html form, specify 'operation' as hidden element.

 



 

Add Requester

The details necessary for adding a requester should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'AddRequester'.

 

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

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:for Requester allowed to view- Show only their own requests,
DEPARTMENT REQUEST:for Requester allowed to view-Show all their Department requests,
SITE REQUEST:for Requester allowed to view-Show all their Site requests

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 SDP Authentication

password

Password for SDP 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:

  1. If the requester is not associated to any department in a site, the site value is automatically set to 'not associated to any site'.

  2. By default, the value for approvePurchase Order is false.

  3. 'approvePurchaseOrder' is enabled only when the email ID of the requester is available.

  4. If 'requestViewPermission' value is vacant, then the value is set as 'Show only their request'.

  5. If a technician with 'SDAdmin' role provides values for 'techSiteName' and 'departmentName' which is unavailable in the database, then the requester is associated to the site and department specified in 'techSiteName' and 'departmentName'.  

  6. If a technician with restricted access permission provides values for 'techSiteName' and 'departmentName' which is unavailable in the database, then the requester is associated to 'Not associated to any site'.

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

 

Update Requester

The details necessary for updating a requester should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'Updaterequester'.

 

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

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:for Requester allowed to view- Show only their own requests,
DEPARTMENT REQUEST:for Requester allowed to view-Show all their Department requests,
SITE REQUEST:for Requester allowed to view-Show all their Site requests

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 SDP Authentication

password

Password for SDP 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:

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

  1. Login information of requesters cannot be edited through API.

  2. 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.

  3. Technician associated only to 'Not associated to any site' will not be allowed to create/edit requesters.

  4. If a technician with 'SDAdmin' role provides values for 'techSiteName' and 'departmentName' which is unavailable in the database, then the requester is associated to the site and department specified in 'techSiteName' and 'departmentName'.  

  5. If a technician with restricted access permission provides values for 'techSiteName' and 'departmentName' which is unavailable in the database, then the requester is associated to 'Not associated to any site'.

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

The details necessary for deleting a requester should be set in HttpRequest parameters and Httprequest parameter value for operation attribute should be 'Updaterequester'.

 

Attributes

Comments

targetURL=

"/servlets/requesterOperationServlet"

target URL for deleting requester

operation='Deleterequesters'

operation command for deleting requester

name

requester Name  

loginName

Requester's Login Name

domainName

Requester's login domain name

emailId

Requester's email ID

userid

Requester id

username

Login Name for SDP Authentication

password

Password for SDP 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.

ServiceDeskPlus - Help Desk and Asset Management Software

Copyright © 2012, ZOHO Corp. All Rights Reserved.
ManageEngine