Method PostSearchStructHdrInfo

Summary

Search Structure Header Info - Coming soon... targeted release 23.1

Remarks

This API will retrieve the application’s Structure Header Information. It will return a list of the application’s structures.

Requires

Input Parameters

NameTypeLengthDescription
projectID System.String 20 [Required] Project ID

Example

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

Return Values

NameDescription
ErrorCode Error Code
ErrorMessage Error Message

Error Details

Error CodeError Message
0000 Success
0001 Project number not found
0013 User does not have authority to structure maintenance

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/EPR/SearchStructHdrInfo";
   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 StructureNumber = row["StructureNumber"].ToString();
             string StructSeqNumber = row["StructSeqNumber"].ToString();
             string StructureDesc = row["StructureDesc"].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 PostSearchStructHdrInfo
   {
       // 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 PostSearchStructHdrInfo()
       {
           //Set any defaults here
       }
   }
}
@* NOTE: Use Add->View to add the View. *@
@* NOTE: Check the 'Create strongly-typed view checkbox, and select the PostSearchStructHdrInfo 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.PostSearchStructHdrInfo

@{
   ViewBag.Title = "PostSearchStructHdrInfo";
}

<h2>PostSearchStructHdrInfo</h2>
@using (Html.BeginForm()) {
   @Html.AntiForgeryToken()
   @Html.ValidationSummary(true)
   <fieldset>
   <legend>PostSearchStructHdrInfo</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/PostSearchStructHdrInfo
public ActionResult PostSearchStructHdrInfo()
{
   // Create a new instance of the model to pick up any default values.
   PostSearchStructHdrInfo model =  new PostSearchStructHdrInfo();

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

// 
// POST: /MyController/PostSearchStructHdrInfo
[HttpPost]
public ActionResult PostSearchStructHdrInfo(FormCollection collection)
{
   string url = "v3/Naviline/EPR/SearchStructHdrInfo";
   // 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", "PostSearchStructHdrInfo");
       return View("Error", info);
   }
}