ServiceDesk Plus

    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

    • 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

    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,

      • 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 neither updated nor deleted.  

    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.

     

    Copyright © 2014, ZOHO Corp. All Rights Reserved.