The following sections describe the full details for these

Recall that when the Request Offering is defined, the user needs to specify whether it is configured as "Published and Subscribe", or "Publish".

The ServiceReqSubscription record (used internally by the Service Catalog) contains the information regarding which Organizational Unit is associated with the Request Offering, and the SLA information, if it is configured relative to the SLA.

In the following sections, several of the Web Methods will make use of the Id value of the ServiceReqSubscription record. For this, a helper web method called GetSubscriptionId() can be used, for obtaining the Subscription Id, which can then be used in any subsequent operations, such as SubmitRequest().

Get the list of available Categories for the Service Catalog.

An FRSHEATGetCategoriesResponse object, defined as follows:

    public class FRSHEATGetCategoriesResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public List<FRSHEATServiceReqCategory> srCategories { get; set; }

    }

The FRSHEATIntegrationFindBOResponse class comprises the following fields:

The FRSHEATServiceReqCategory class is defined as follows:

    public class FRSHEATServiceReqCategory

    {

        public string strRecId;

        public string strName;

        public string strDescription;

    }

The FRSHEATServiceReqCategory class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            FRSHEATGetCategoriesResponse getCategoriesResponse = frSvc.GetCategories(authSessionKey, tenantId);

            if (getCategoriesResponse.status == "Success")

            {

                foreach (FRSHEATServiceReqCategory srCategory in getCategoriesResponse.srCategories)

                {

                    Console.WriteLine("Category: ", srCategory.strName);

                }

            }

Get the list of Request Offerings in the Service Catalog, which belong to the indicated Category

An FRSHEATGetTemplatesResponse object, defined as follows:

    public class FRSHEATGetTemplatesResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public List<FRSHEATServiceReqTemplateListItem> srtList { get; set; }

    }

The FRSHEATGetTemplatesResponse class comprises the following fields:

The FRSHEATServiceReqTemplateListItem class is defined as follows:

    public class FRSHEATServiceReqTemplateListItem

    {

        public string strRecId;

        public string strName;

        public string strDescription;

        public string strSubscriptionId;

    }

The FRSHEATServiceReqTemplateListItem class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            FRSHEATGetTemplatesResponse getTemplatesResponse = frSvc.GetCategoryTemplates(authSessionKey, tenantId, categoryid, searchString);

            if (getTemplatesResponse.status == "Success")

            {

                foreach (FRSHEATServiceReqTemplateListItem srTemplateListItem in getTemplatesResponse.srtList)

                {

                    Console.WriteLine("Request Offering:  ", srTemplateListItem.strSubscriptionId, srTemplateListItem.strName);

                }

            }

Get the full list of Request Offerings in the Service Catalog

public FRSHEATGetTemplatesResponse GetAllTemplates(string sessionKey, string tenantId)

An FRSHEATGetTemplatesResponse object, defined as follows:

    public class FRSHEATGetTemplatesResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public List<FRSHEATServiceReqTemplateListItem> srtList { get; set; }

    }

The FRSHEATGetTemplatesResponse class comprises the following fields:

The FRSHEATServiceReqTemplateListItem class is defined as follows:

    public class FRSHEATServiceReqTemplateListItem

    {

        public string strRecId;

        public string strName;

        public string strDescription;

        public string strSubscriptionId;

    }

The FRSHEATServiceReqTemplateListItem class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            FRSHEATGetTemplatesResponse getTemplatesResponse = frSvc.GetAllTemplates(authSessionKey, tenantId);

            if (getTemplatesResponse.status == "Success")

            {

                foreach (FRSHEATServiceReqTemplateListItem srTemplateListItem in getTemplatesResponse.srtList)

                {

                    Console.WriteLine("Request Offering:  ", srTemplateListItem.strSubscriptionId, srTemplateListItem.strName);

                }

            }

Fetches the Subscription ID corresponding to the Request Offering for the current user

An FRSHEATGetSubscriptionIdResponse object, defined as follows:

    public class FRSHEATGetSubscriptionIdResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public string subscriptionId { get; set; }

    }

The FRSHEATGetSubscriptionIdResponse class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            FRSHEATGetSubscriptionIdResponse subscriptionIdResponse = frSvc.GetSubscriptionId(authSessionKey, tenantId, offeringName);

            string offeringname = "Domain Password Reset";

            if (subscriptionIdResponse.status == "Success")

            {

                string subscriptionId = subscriptionIdResponse.subscriptionId;

                Console.WriteLine("The Subscription Id for the \"\" Request Offering is ", offeringName, subscriptionId);

            }  

Retrieve the details of the indicated Request Offering

An FRSHEATGetPackageDataResponse object, defined as follows:

    public class FRSHEATGetPackageDataResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public FRSHEATServiceReqSubscription srSubscription { get; set; }

    }

The FRSHEATGetPackageDataResponse class comprises the following fields:

The FRSHEATServiceReqSubscription class is defined as follows:

    public class FRSHEATServiceReqSubscription

    {

        public string strSubscriptionRecId;

        public string strDateSubscribed;

        public string strOrgUnitId;

        public string strName;

        public string strDescription;

        public string strServiceName;

        public string strRecId;

        public List<FRSHEATServiceReqTemplateParam> lstParameters;

    }

The FRSHEATServiceReqTemplateListItem class comprises the following fields:

The FRSHEATServiceReqTemplateParam class is defined as follows:

    public class FRSHEATServiceReqTemplateParam

    {

        public string strName;

        public string strLabel;

        public string strDescription;

        public string strType;

        public bool bAllowSelectByUser;

        public bool bDBValidated;

        public string strRequiredExpression;

        public bool isCalculated;

        public bool autoFillOnlyWhenEmpty;

        public string strValidationListRecId;

        public string strValidationListTableRef;

        public bool bIsHidden;

        public string strRecId;

        public List<ValidationConstraint> validationConstraints;

        public string strValidationConstraints;

        public string strAutoFillExpression;

        public List<string> triggerFields;

        public string strTriggerFields;

        public string strDefaultValue;

    }

The FRSHEATServiceReqTemplateListItem class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            FRSHEATGetPackageDataResponse getPackageDataResponse = frSvc.GetPackageData(authSessionKey, tenantId, strSubscrRecId);

            FRSHEATServiceReqSubscription scsrs;

            if (getPackageDataResponse.status == "Success")

            {

                scsrs = getPackageDataResponse.srSubscription;

                // Go ahead and access the relevant properties of interest from the Request Offering ..

            }

Check whether the current user is entitled to access the given Request Offering

An FRSHEATUserCanAccessReqOfferingResponse object, defined as follows:

    public class FRSHEATUserCanAccessReqOfferingResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public bool canAccess { get; set; }

    }

The FRSHEATUserCanAccessReqOfferingResponse class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            string loginId = "ASimon";

            string reqOfferingName = "Domain Password Reset";

            FRSHEATUserCanAccessReqOfferingResponse canAccessReqOfferingResponse = frSvc.UserCanAccessRequestOffering(sessionKey, tenantId, loginId, reqOfferingName);

            if (canAccessReqOfferingResponse.status == "Success")

            {

                if (canAccessReqOfferingResponse.canAccess)

                {

                    Console.WriteLine("User  can access the Request Offering ", loginId, reqOfferingName);

                }

                else

                {

                    Console.WriteLine("User  has no access to the Request Offering ", loginId, reqOfferingName);

                }

            }

Creates and submits the Service Request, on behalf of a given user

An FRSHEATServiceReqParam class is defined as follows:

    public class FRSHEATServiceReqParam

    {

        public string strName;

        public string strValue;

    }

The FRSHEATServiceReqParam class comprises the following fields:

strName: name of the parameter

strValue: value for the parameter

Return Value:

An FRSHEATSubmitRequestResponse object, defined as follows:

    public class FRSHEATSubmitRequestResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public FRSHEATServiceReqRequest reqData { get; set; }

    }

The FRSHEATSubmitRequestResponse class comprises the following fields:

The FRSHEATServiceReqRequest class is defined as follows:

    public class FRSHEATServiceReqRequest

    {

        public string strRequestRecId;

        public string strRequestNum;

        public decimal fTotalPrice;

        public decimal fTotalRecurPrice;

        public string strByEmployee;

        public string strFulfillmentPlanType;

        public string strUrgency;

        public DateTime? DateSubmitted;

        public DateTime? DateUpdated;

        public string strUpdatedBy;

        public DateTime? DateDelivery;

        public string strSubscriptionRecId;

        public bool isFulfilled;

        public string strName;

        public string strDescription;

        public decimal fPrice;

        public decimal fRecurPrice;

        public int nRecurPeriod;

        public int nDeliveryCommitment;

        public string strStatus;

        public string strCreatedBy;

        public string strRecId;

        public List<FRSHEATServiceReqTemplateParam> lstParameters;

}

The FRSHEATServiceReqRequest class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

Before submitting the Service Request, the SubmitRequest Web Method performs three types of validation:

Prior to submitting the Service Request, the SubmitRequest Web Method will perform the data type checking of the values, with respect to the data types of the respective parameters.

The following table summarizes the various parameter types. If data type validation is performed, the details section will describe this information in greater detail.

            string strSubscrRecId = frSvc.GetSubscriptionId(authSessionKey, tenantId, "Domain Password Reset").subscriptionId;

            List<FRSHEATServiceReqParam> srparamListItems = new List<FRSHEATServiceReqParam>();

            srparamListItems.Add(new FRSHEATServiceReqParam

            {

                strName = "RequesterDepartment",

                strValue = "IT"

            });

            srparamListItems.Add(new FRSHEATServiceReqParam

            {

                strName = "Requester",

                strValue = "Ashley Simon"

            });

            FRSHEATSubmitRequestResponse srResponse = frSvc.SubmitRequest(authSessionKey, tenantId, strSubscrRecId, srparamListItems.ToArray(), loginId);

            FRSHEATServiceReqRequest srres;

            if (srResponse.status == "Success")

            {

                srres = srResponse.reqData;

            }

            else

            {

                if (srResponse.exceptionReason != null)

                {

                    Console.WriteLine("Error: " + srResponse.exceptionReason);

                }

            }

Retrieves the data for the given Service Request

public FRSHEATGetRequestDataResponse GetRequestData(string sessionKey, string tenantId, string strReqNumber)

sessionKey: Key received in the earlier Connect request

tenantId: tenant for which the key is authenticated.

strReqNumber: numeric ID value for the Service Request

Return Value:

An FRSHEATGetRequestDataResponse object, defined as follows:

    public class FRSHEATGetRequestDataResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public FRSHEATServiceReqRequest reqData { get; set; }

    }

The FRSHEATGetRequestDataResponse class comprises the following fields:

Refer to the earlier SubmitRequest section, regarding the definition of the FRSHEATServiceReqRequest class.

The following table lists the available status values, and describes how to interpret them.

            FRSHEATGetRequestDataResponse getRequestDataResponse = frSvc.GetRequestData(authSessionKey, tenantId, strReqRecId);

            FRSHEATServiceReqRequest srRequest;

            if (getRequestDataResponse.status == "Success")

            {

                srRequest = getRequestDataResponse.reqData;

                // Go ahead and access the relevant properties of interest from the Service Request ..

            }

Fetch the allowable validation list data for the given Service Request parameter

An FRSHEATFetchSRValListDataResponse object, defined as follows:

    public class FRSHEATFetchSRValListDataResponse

    {

        public string status { get; set; }

        public string exceptionReason { get; set; }

        public List<FRSHEATValListValue> validationValuesList { get; set; }

    }

The FRSHEATFetchSRValListDataResponse class comprises the following fields:

The FRSHEATValListValue class is defined as follows:

    public class FRSHEATValListValue

    {

        public string strRecId;

        public string strStoredValue;

        public string strDisplayValue;

    }

The FRSHEATValListValue class comprises the following fields:

The following table lists the available status values, and describes how to interpret them.

            // Fetch the matching validation list records for Requester, in the "Domain Password Reset" Request Offering

            // Since the Requester is constrained by the "RequesterDeparment" parameter, this needs to be specified as an input parameter to the Web Method

            string offeringName = "Domain Password Reset";

            string paramName = "Requester";

            FRSHEATDepValItem depValItem = new FRSHEATDepValItem()

            {

                strParName = "RequesterDepartment",

                strParValue = "IT"

            };

            FRSHEATFetchSRValListDataResponse validationValuesResponse = frSvc.FetchServiceReqValidationListData(authSessionKey, tenantId, offeringName, paramName, depValItem, subStrQuery);

            FRSHEATValListValue[] valListValues;

            if (validationValuesResponse.status == "Success")

            {

                valListValues = validationValuesResponse.validationValuesList;

                Console.WriteLine("Here are the matching validation list records:\n");

                foreach (FRSHEATValListValue valListItem in valListValues)

                {

                    Console.WriteLine("Stored Value: \"\"\t\tDisplay Value: \"\"", valListItem.strStoredValue, valListItem.strDisplayValue);

                }

            }

As explained in the earlier Introduction section, the FRSHEATIntegration Web Service uses standard Web Service technologies, and can be consumed using various programming languages / platforms such as Microsoft .NET, Java, etc.

This section describes how one would create a test console application using Visual Studio 2010, specifically for creating the Web Reference to access the SOAP-based FRSHEATIntegration API.

Note that alternative .NET based clients such as WPF, ASP.NET, and Windows Forms clients can also be created, using the same concepts as presented here.

To create a new test console application in Visual Studio, follow these steps: