Site Attributes and xml Response

The operations that can be performed on sites are described below

Note

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

2. Technicians with SDAdmin and SDAccountAdmin privilige can add / update / delete a site.

3. Technicians with SDSiteAdmin privilige can update a site, but do not have permission to set 'Related Settings'

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

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

Add Site
Update Site
Delete Site

Add Site

To create a site, the targetURL attribute should be set to /servlets/SiteServlet and the 'operation' attribute should be 'AddSite'. The 'accountName' and 'siteName' parameters are mandatory.

Attributes	Comments
targetURL= "/servlets/SiteServlet"	target url for adding site
operation='AddSite'	operation command for Adding site.
accountName	Name of the account
siteName	Name of the site
description	Description for the site
region	The Region to which the site belongs
timeZone	Time Zone of the site
doorNo	Site address.
street	Site address
landmark	Provide a landmark if required.
city	City where the site is located.
postalCode	Postal code for the site
state	State/county/province where the site is located.
country	The country where the site is located
email	Email address for the site.
phone	Site phone number.
fax	Fax number of the site.
webUrl	website of the site.
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 ServiceDesk Plus - MSP Authentication
password	Password for ServiceDesk Plus - MSP 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:

If the Region specified for the site is not configured in the ServiceDesk Plus - MSP, then the region field does not get populated in the application.
If any of the Related Settings other than DepartmentSettings is left unselected, 'Refer Default Settings' option is selected as default. In the case of DepartmentSettings, 'Custom' is selected by default.
If any one of TechSiteAssociationSettings, GroupsSettings, BusinessRulesSettings or SLASettings is selected as 'Refer Default Settings', the other three are also set to refer.

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

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

A failure message appears if,

A technician without admin permission is trying to add a new site. [xml response]
The specified site name already exists. [xml response]

Update Site

To update a site, the targetURL attribute should be set to /servlets/SiteServlet and the 'operation' attribute should be 'UpdateSite'. The 'accountName' and 'oldSiteName' parameters are mandatory.

Attributes	Comments
targetURL= "/servlets/SiteServlet"	target url for editing/updating a site
operation='UpdateSite'	operation command for updating site.
accountName	Name of the account
oldSiteName	Existing site name
siteName	New name for the site
description	Description for the site
region	The Region to which the site belongs
timeZone	Time Zone of the site
doorNo	Site address.
street	Site address
landmark	Provide a landmark if required.
city	City where the site is located.
postalCode	Postal code for the site
state	State/county/province where the site is located.
country	The country where the site is located
email	Email address for the site.
phone	Site phone number.
fax	Fax number of the site.
webUrl	website of the site.
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 ServiceDesk Plus - MSP Authentication
password	Password for ServiceDesk Plus - MSP 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:

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

The sample form to update a site can be viewed here.

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

Delete Site

To delete a site, the targetURL attribute should be set to /servlets/SiteServlet and the 'operation' attribute should be 'DeleteSite'. The 'accountName' and 'siteName' parameters are mandatory.

Attributes	Comments
targetURL="/servlets/SiteServlet"	target url for deleting a site
operation='DeleteSite'	operation command for deleting site
accountName	Name of the account
siteName	Site Name
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 site can be accessed here.

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

A Failure message appears if,

A SiteAdmin is trying to delete the sites. [xml response]
If the site is used by a module. [xml response]