Method GetUserCodeByCode

Summary

Get User Code by Code

Remarks

Get Land Management User-defined code information by code

Requires

Input Parameters

NameTypeLengthDescription
MiscCode System.String 4 [Required] User defined code

Example

GET http://localhost/FusionServices/v2/NaviLine/Land/UserCodeByCode/{MiscCode}

Return Values

NameDescription
Function Function command sent to retrieve the record. Internal use only.
Order Ordering code sent to retrieve the record. Internal use only.
Error Indicates if the record was found or not. 0=Found, 1=Not Found
MiscCode Miscellaneous Information Code
MiscCodeDesc Miscellaneous Information Description
MiscCodeAppl Miscellaneous Information Application Code
SpecialNote Special Note Code. Blank=No special process, C=Critical, S=Special
ApplInd1 Application Index 1
ApplInd2 Application Index 2
ApplInd3 Application Index 3
UserDefined User Defined
UserDefSubCode User Defined Code
UserDefSubCodeDesc User Defined Description
RequiredSubCode Required Code
RequiredSubCodeNo Required Code Number
RequiredSubCodeText Required Code Text
RequiredSubCodeDate Required Code Date
DisplayPriority Display Priority
ErrorCode 0000=Successful
ErrorMessage Returned message
Status Returned status. Successful, Rejected, Error

Sample Responses

Sample Code

using System.Net;

public void MethodName(parms){
    string uri = "http://localhost/FusionServices/v2/NaviLine/Land/UserCodeByCode/ESMT";
    WebClient wc = new WebClient();
    Common.SetResponseType(wc, "json");
    Common.SetLicenseKey(wc);
    string stringResult = wc.DownloadString(new Uri(uri));
    
    JObject response = JObject.Parse(stringResult);
    string error = response["OutputParms"]["ErrorCode"].ToString();
    if (error != "0000")
    {
       // TODO
    }
}

$.get('http://localhost/FusionServices/v2/NaviLine/Land/UserCodeByCode/ESMT', 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 GetUserCodeByCode
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,4}$).*", ErrorMessage = "Must be 4 characters or less. ")]
       public string MiscCode{get; set;}

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

@{
   ViewBag.Title = "GetUserCodeByCode";
   string myUrl = "http://localhost/FusionServices/v2/NaviLine/Land/UserCodeByCode/" + Model.MiscCode;
}

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

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

// 
// POST: /MyController/GetUserCodeByCode
[HttpPost]
public ActionResult GetUserCodeByCode(FormCollection collection)
{
   string url = "v2/NaviLine/Land/UserCodeByCode/{MiscCode}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("MiscCode", collection["MiscCode"]);

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