Method PostSearchStructCodes

Summary

Search Structure Codes - Coming soon... targeted release 23.1

Remarks

This API will retrieve the Structure Codes. It will return a list of the structures for the Item ID.

Requires

Input Parameters

NameTypeLengthDescription
itemType System.String 1 [Required] Item Type (‘1’ or ‘2’):1 – System codes;2 – User-defined codes
itemID System.String 4 [Required] Item ID

Example

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

Return Values

NameDescription
ErrorCode Error Code
ErrorMessage Error Message

Error Details

Error CodeError Message
0000 Success
0014 Invalid item type

Sample Responses

Sample Code

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

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

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

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

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

@{
   ViewBag.Title = "PostSearchStructCodes";
}

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

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

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

   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", "PostSearchStructCodes");
       return View("Error", info);
   }
}