Method GetWorkRequestComments

Summary

Get Work Request Comments - Coming soon ... targeted release 22.2

Remarks

Work request comment retrieval - This API currently provides the ability to retrieve either the detailed description comments OR the result comments associated with a single work request.

Input Parameters

NameTypeLengthDescription
workReqNumber System.String 9 [Required] Work Request Number
commentType System.String 1 [Required] Type of comments to be retrieved. ‘D’ – Detailed description;‘R’ – Result comments

Example

GET http://localhost/FusionServices/v3/Naviline/WorkOrders/WorkRequestComments/WF0180940/R

Return Values

NameDescription
OUT_ERRCDE 0000
OUT_ERRDSC Success

Sample Responses

Sample Code

using System.Net;
using Newtonsoft.Json.Linq;

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v3/Naviline/WorkOrders/WorkRequestComments/WF0180940/R";
    WebClient wc = new WebClient();
    wc.Headers.Set("X-APPID", "YOURID");
    wc.Headers.Set("X-APPKEY", "YOURKEY");
    string stringResult = wc.DownloadString(new Uri(uri));
    
    JObject response = JObject.Parse(stringResult);
    string error = response["OutputParms"]["ErrorCode"].ToString();
    if (error == "0000")
    {
        JArray jRows = (JArray)response["Rows"];
        foreach (JObject row in jRows)
        {
             string REQUESTNBR = row["REQUESTNBR"].ToString();
             string COMMENTSEQ = row["COMMENTSEQ"].ToString();
             string COMMENTTXT = row["COMMENTTXT"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v3/Naviline/WorkOrders/WorkRequestComments/WF0180940/R', function(response) {
    $('#resultDiv).html(response); 
 });

C# Razor MVC Sample Code

using System;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
using System.Collections.Specialized;
using FusionServiceHelper.Models;

// NOTE: Use the namespace generated when you add the class, so that it is correct.
namespace FusionRazor.Models
{
   public class GetWorkRequestComments
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,9}$).*", ErrorMessage = "Must be 9 characters or less. ")]
       public string workReqNumber{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,1}$).*", ErrorMessage = "Must be 1 characters or less. ")]
       public string commentType{get; set;}

       public GetWorkRequestComments()
       {
           //Set any defaults here
           workReqNumber = DefaultData.Get("workReqNumber");
           commentType = DefaultData.Get("commentType");
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the GetWorkRequestComments class. *@
@* NOTE: Select Edit as the Scaffold template. *@
@* NOTE: Use the @model line that is generated at the top.  Replace the rest with the lines below.
@model FusionRazor.Models.GetWorkRequestComments

@{
   ViewBag.Title = "GetWorkRequestComments";
   string myUrl = "http://localhost/FusionServices/v3/Naviline/WorkOrders/WorkRequestComments/WF0180940/R";
}

<h2>GetWorkRequestComments</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>GetWorkRequestComments</legend>
       <div class="editor-label">Use the fields below to change the values and resubmit.</div>
       <div class="editor-label">
           @Html.LabelFor(model => model.workReqNumber)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.workReqNumber)
           @Html.ValidationMessageFor(model => model.workReqNumber)
       </div>
       <div class="editor-label">
           @Html.LabelFor(model => model.commentType)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.commentType)
           @Html.ValidationMessageFor(model => model.commentType)
       </div>
       <p>
       <input type="submit" value="Submit"/>
       </p>
   </fieldset>

}

@section Scripts {
   @Scripts.Render("~/bundles/jqueryval")
}
using System;
using System.Collections.Specialized;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using FusionServiceHelper.Models;

// NOTE: Replace 'MyController' with the name of your controller.

// 
// GET: /MyController/GetWorkRequestComments
public ActionResult GetWorkRequestComments()
{
   // Create a new instance of the model to pick up any default values.
   GetWorkRequestComments model =  new GetWorkRequestComments();

   // pass model to set to default values
   // NOTE: Change 'MyFolderPath' to the path to the .cshtml file.
   return View("~/Views/MyFolderPath/GetWorkRequestComments.cshtml", model);
}

// 
// POST: /MyController/GetWorkRequestComments
[HttpPost]
public ActionResult GetWorkRequestComments(FormCollection collection)
{
   string url = "v3/Naviline/WorkOrders/WorkRequestComments/WF0180940/R";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("workReqNumber", collection["workReqNumber"]);
   inputParms.Add("commentType", collection["commentType"]);

   try
   {
       // Send the request
       FusionServiceRequest request = new FusionServiceRequest();
       FusionServiceResult result = request.Get(url, inputParms);

       return View("Result", result);
   }
   catch(Exception e)
   {
       HandleErrorInfo info = new HandleErrorInfo(e, "MyController", "GetWorkRequestComments");
       return View("Error", info);
   }
}