Method PostSearchPlanReviewSteps

Summary

Search Plan Review Steps - Coming soon... targeted release 23.1

Remarks

This API will return the review steps for the project. It will return a data set of the review steps for the project/application that are flagged for electronic review.

Requires

Input Parameters

NameTypeLengthDescription
projectID System.String 20 [Required]

Example

POST http://localhost/FusionServices/v3/Naviline/EPR/SearchPlanReviewSteps

Return Values

NameDescription
ErrorCode Error Code
ErrorMessage Error Message
TrkRevNumber Tracking Revision Number
ApplTrkPath Application Tracking Path
ApplTrkStep Applicaiton Tracking Step
AgencyCode Agency Code
StepSeqNumber Step Sequence Number
DateIn Date In (CCYYMMDD)
DateDue Date Due (CCYYMMDD)
DateOut Date OUt (CCYYMMDD)
ActualApprCode Actual Approval Code
ReviewedByCode Reviewed By Code
ReqdStepFlag Required Step Flag (Y/N)>
ReqdApprCode Required Approval Code

Error Details

Error CodeError Message
0000 Success
0001 Project number not found

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/EPR/SearchPlanReviewSteps";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("projectID",System.Web.HttpUtility.UrlEncode("2200198"));

   WebClient req = new WebClient();
   wc.Headers.Add("Content-Type", "application/x-www-form-urlencoded");
   wc.Headers.Set("X-APPID", "YOURID");
   wc.Headers.Set("X-APPKEY", "YOURKEY");

   byte[] responseBytes = wc.UploadValues(new Uri(uri), "POST", postParms);
   string stringResult = Encoding.UTF8.GetString(responseBytes); 
   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 TrkRevNumber = row["TrkRevNumber"].ToString();
             string ApplTrkPath = row["ApplTrkPath"].ToString();
             string ApplTrkStep = row["ApplTrkStep"].ToString();
             string AgencyCode = row["AgencyCode"].ToString();
             string StepSeqNumber = row["StepSeqNumber"].ToString();
             string DateIn = row["DateIn"].ToString();
             string DateDue = row["DateDue"].ToString();
             string DateOut = row["DateOut"].ToString();
             string ActualApprCode = row["ActualApprCode"].ToString();
             string ReviewedByCode = row["ReviewedByCode"].ToString();
             string ReqdStepFlag = row["ReqdStepFlag"].ToString();
             string ReqdApprCode = row["ReqdApprCode"].ToString();
             // TODO - YOUR CODE HERE
        }
   }
}

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 PostSearchPlanReviewSteps
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,20}$).*", ErrorMessage = "Must be 20 characters or less. ")]
       public string projectID{get; set;}

       public PostSearchPlanReviewSteps()
       {
           //Set any defaults here
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the PostSearchPlanReviewSteps 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.PostSearchPlanReviewSteps

@{
   ViewBag.Title = "PostSearchPlanReviewSteps";
}

<h2>PostSearchPlanReviewSteps</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>PostSearchPlanReviewSteps</legend>
       <div class="editor-label">
           @Html.LabelFor(model => model.projectID)
       </div>
       <div class="editor-field">
           @Html.EditorFor(model => model.projectID)
           @Html.ValidationMessageFor(model => model.projectID)
       </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/PostSearchPlanReviewSteps
public ActionResult PostSearchPlanReviewSteps()
{
   // Create a new instance of the model to pick up any default values.
   PostSearchPlanReviewSteps model =  new PostSearchPlanReviewSteps();

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

// 
// POST: /MyController/PostSearchPlanReviewSteps
[HttpPost]
public ActionResult PostSearchPlanReviewSteps(FormCollection collection)
{
   string url = "v3/Naviline/EPR/SearchPlanReviewSteps";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("projectID", collection["projectID"]);

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

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