ServiceDesk Plus

    Technician Attributes and xml Response

     

    The technician attributes along with their actions should be used as defined below.  
     

     

    Note

     

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

    2. Only technicians with roles of SDAdmin and SDSiteAdmin can perform add, update and delete operations.

    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 Technician

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

     

    Attributes

    Comments

    targeturl=

    "/servlets/technicianservlet"

    target url for Adding technician

    operation='addtechnician'

    operation command for Adding technician.

    name

    Technician name

    employeeid

    Employee ID of the technician

    email

    Email Address of the technician

    phone

    Phone Number of the technician

    mobile

    Mobile number of technician

    smsmailId

    SMS mail id of technician

    costperhr

    technician's cost per hour

    departmentname

    department name to which the technician is associated to.

    techsitename

    site name to which the technician is associated to.

    jobtitle

    Job title of the technician.

    associatesites

    Associated sites of the technician

    associategroups

    Associated groups of the technician

    approvepurchaseorder

    Purchase Order Approver
    Allowed Values:true,false.

    UDF aliases name

    additional fields should be specified based on their column names

    enablelogin

    parameter for Enable Login for Technician
    Allowed Values:true,false.

    loginname

    Technician's login name

    pwd

    Technician's password

    userdomainname

    Domain to which the technician belongs to

    associaterols

    roles associated with the technician  

    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 technician is associated to many sites, the sites should be specified in comma separated format in 'associateSites' say, India, US, London.

    2. If the technician is assigned to more than one group, the groups should be specified in comma separated format in 'associateGroups' as sitename-groupname'.

    3. If the technician is 'Not associated to any site', specify the value as 'default' in 'associateSites'.

    4. To assign a technician to a department of 'Not associated to any site ', 'techSiteName' should be specified as 'default'.

    5. If invalid values are provided for 'departmentName' and 'techSiteName', then technician is associated to 'Not associated to any site'.

    6. 'approvePurchaseOrder' is enabled only when the email ID of the technician is specified. The values permitted for 'approvePurchaseOrder' are 'true' and 'false'. By default, the value is 'false'.

    7. The values permitted for 'enableLogin' are 'true' and 'false'. By default, the value is 'false'.

    8. If 'pwd' is not specified, the pwd for the technician is the same as the specified 'loginName'.

    9. Login is not provided to the technician if 'loginName' is not specified.

    10. Technicians with SDSiteAdmin privileges but restricted access permissions can add technicians only for their associated sites.

     

    The sample form to add a new technician can be viewed here.

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

    A failure message appears if,

    1. a technician without admin privilege is trying to add a technician. [xml response]

    2. A technician with restricted access is trying to create a technician not associated to his site. [xml response]

    3. the specified technician login name already exists [xml response]

     

    Update Technician

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

     

    Attributes

    Comments

    targeturl=

    "/servlets/technicianservlet"

    target url for Updating technician.

    operation='updatetechnician'

    operation command for Updating technician.

    techusername

    Technician Name to update

    techloginname

    Login Name of the technician

    techdomainname

    Domain Name to which technician the technician belongs

    techemailId

    Email ID of the technician

    userid

    Technician ID

    name

    Technician name

    employeeid

    Employee ID of the technician

    email

    Email Address of the technician

    phone

    Phone Number of the technician

    mobile

    Mobile number of technician

    smsmailid

    SMS mail id of technician

    costperhr

    technician's cost per hour

    departmentname

    department name to which the technician is associated to.

    techsitename

    site name to which the technician is associated to.

    jobtitle

    Job title of the technician.

    associatesites

    Associated sites of the technician

    associategroups

    Associated groups of the technician

    UDF aliases name

    additional fields should be specified based on their column names

    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, technicians are identified based on the order below,

    1. The users are first identified based on the 'techLoginName' and 'techDomainName'.

    2. If the 'techDomainName' is not specified, the user is identified based on the 'techLoginName' with 'techDomainName' as an empty value.

    3. If the technician does not fall under the above criteria, the user is identified based on the 'techEmailid'.

    4. If the technician is unavailable in the above specified criteria, the technician is identified based on the 'techUserName'.

    5. If the technician cannot be identified from the above criteria, then the technician is identified based on 'userid'.

    6. Based on the reqUserName or reqEmailId, if more than one technicians are identified then the technician details is neither updated nor deleted.  

    1. Login details and 'approvePurchaseOrder' value cannot be updated through API.

    2. Technicians with SDSiteAdmin privileges but restricted access permissions can add technicians only for their associated sites.

     

    The sample form to update technicians can be accessed here.

    A success message appears if the technician is updated successfully.

    A failure message appears if,

    1. A technician without admin privilege is trying to update a technician. [xml response]

    2. A technician with restricted access is trying to update a technician not associated to his site. [xml response]

     

    Delete Technician

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

     

    Attributes

    Comments

    targeturl=

    "/servlets/technicianoperationservlet"

    target urll for deleting technician

    operation='deletetechnician'

    operation command for deleting technician

    name

    Technician Name  

    loginname

    Technician's Login Name

    domainname

    Technician's login domain name

    emailid

    Technician's email ID

    userid

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

    Note:

    1. Technician with 'SDAdmin' can be deleted only by other 'SDAdmin'.

     

    The sample form to delete a technician can be viewed here.

    The response in xml displays a Success message if the technician has permission to delete technicians.

     

     

    Copyright © 2014, ZOHO Corp. All Rights Reserved.