Site Attributes and xml Response

 

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

 Note

 

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

2. Site operations can be performed by technicians only with administrator privilege. The Site Administrator can neither add, edit nor delete a site.

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 Site

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

 

Attributes

Comments

targeturl=

"/servlets/siteservlet"

target url for adding site

operation='addsite'

operation command for Adding site.

sitename

Organization Name

description

Description for the site

region

The Region to which the site belongs

timezone

Time Zone of the site  

doorno

Address of the organization.  

street

Address where the company is located in the specified site.

landmark

Provide a landmark if required.

city

City where the company is located.

postalcode

Address where the company is located in the specified site.

state

Address where the company is located in the specified site.

country

Address where the company is located in the specified site.

email

Email address of the organization.

phone

contact information of the organization.

fax

Fax number of the organization.

weburl

website of the organization.

operationalhourssettings

Related Settings for Operational hours of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

holidayssettings

Related Settings for Holidays setting of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

departmentssettings

Related Settings for Departments setting of the site. Allowed values:

copy (Copy Default Settings),

custom (Custom Settings)

techsiteassociationsettings

Related Settings for Technicians/Site Association setting of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

groupssettings

Related Settings for Groups setting of the site. Allowed values:
copy
(Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

businessrulessettings

Related Settings for Business Rules setting of the site. Allowed values:
copy
(Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

slasettings

Related Settings for Service Level Agreements setting of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

username

Login Name for SDP Authentication

password

Password for SDP Authentication

domain_name

Domain Name to which the user belongs. Domain Name should be specified on enabling AD authentication.

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 Region specified for the site is not configured in the ServiceDesk Plus, then the region field does not get populated in the application.

  2. If any of the Related Settings other than DepartmentSettings is left unselected, 'Refer Default Settings' option is selected is selected as default. In the case of DepartmentSettings, Custom Default Settings is selected by default.

  3. If any of the following namely, TechSiteAssociationSettings, GroupsSettings, BusinessRulesSettings or SLASettings is selected as Refer Default Settings, the other three is set to refer in the application.

  4. Technicians with SDSiteAdmin role have the privilege to edit the site information. However, they cannot edit 'Related Settings.'   

 

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

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

A failure message appears if,

 

Update Site

The details to be updated should be set in the http request parameters with the 'operation' command as 'Update'. It is a mandatory field while updating a site.  

 

Attributes

Comments

targeturl=

"/servlets/siteservlet"

target url for adding site

operation='updatesite'

operation command for Adding site.

oldsitename

Site Name for update

sitename

New Organization Name

description

Description for the site

region

The Region to which the site belongs

timezone

Time Zone of the site  

doorno

Address of the organization.  

street

Address where the company is located in the specified site.

landmark

Provide a landmark if required.

city

City where the company is located.

postalcode

Address where the company is located in the specified site.

state

Address where the company is located in the specified site.

country

Address where the company is located in the specified site.

email

Email address of the organization.

phone

contact information of the organization.

fax

Fax number of the organization.

webUrl

website of the organization.

operationalhourssettings

Related Settings for Operational hours of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

holidayssettings

Related Settings for Holidays setting of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

departmentssettings

Related Settings for Departments setting of the site. Allowed values:

copy (Copy Default Settings),

custom (Custom Settings)

techsiteassociationsettings

Related Settings for Technicians/Site Association setting of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

groupssettings

Related Settings for Groups setting of the site. Allowed values:
copy
(Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

businessrulessettings

Related Settings for Business Rules setting of the site. Allowed values:
copy
(Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

slasettings

Related Settings for Service Level Agreements setting of the site. Allowed values:

copy (Copy Default Settings),

refer (Refer Default Settings),

custom (Custom Settings)

username

Login Name for SDP Authentication

password

Password for SDP Authentication

domain_name

Domain Name to which the user belongs. The Domain Name should be specified on enabling AD authentication.  

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 update sites can be viewed here.

A Success message appears in the xml form when the site details are updated successfully.

 

Delete Site

The 'siteName' parameter along with the operation command as 'DeleteSite' should be set in HttpRequest parameters.

 

Attributes

Comments

targeturl="/servlets/siteservlet"

target url for Adding site

operation='deletesite'

operation command for deleting site

sitename

Organization Name

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 site can be accessed here.

A Success message appears in xml format once the site is deleted successfully.  

A Failure message appears if,

ServiceDeskPlus - Help Desk and Asset Management Software

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