Method PostUpdateXRef

Summary

Update BP Cross Reference - Coming soon... targeted release 23.1

Remarks

This API will update the BP cross reference file for ePlan. The application (Year and Number) in BP - Eplan Cross reference file (BP200DX) will be updated with the Project ID from ePlan.

Requires

Input Parameters

NameTypeLengthDescription
applicationYear System.String 2 [Required] Application Year
applicationNumber System.String 8 [Required] Application Number
projectID System.String 20 [Required] Project ID

Example

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

Return Values

NameDescription
ErrorCode Error Code
ErrorMessage Error Message

Error Details

Error CodeError Message
0000 Success
0002 Application year and number not found
0021 Project Dox project ID already exist

Sample Responses

Sample Code

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

public void MethodName(parms)
{
   string uri = "http://localhost/FusionServices/v3/Naviline/EPR/UpdateXRef";
   System.Collections.Specialized.NameValueCollection postParms = 
     new System.Collections.Specialized.NameValueCollection(); 
   // Set paramater values
   postParms.Add("applicationYear",System.Web.HttpUtility.UrlEncode("22"));
   postParms.Add("applicationNumber",System.Web.HttpUtility.UrlEncode("00000198"));
   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")
   {
         // 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 PostUpdateXRef
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("^(?=.{0,2}$).*", ErrorMessage = "Must be 2 characters or less. ")]
       public string applicationYear{get; set;}

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

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

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

@{
   ViewBag.Title = "PostUpdateXRef";
}

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

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

// 
// POST: /MyController/PostUpdateXRef
[HttpPost]
public ActionResult PostUpdateXRef(FormCollection collection)
{
   string url = "v3/Naviline/EPR/UpdateXRef";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("applicationYear", collection["applicationYear"]);
   inputParms.Add("applicationNumber", collection["applicationNumber"]);
   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", "PostUpdateXRef");
       return View("Error", info);
   }
}