Method GetW2InformationDetails

Summary

Get W2 Information Details

Remarks

Returns a row for each of the boxes on the W2 form that describes the box and gives the value.

Input Parameters

NameTypeLengthDescription
employeeNumber numeric 10 [Required] Employee Number. May need to be padded left with zeros to make it 10 digits.
year numeric 4 [Required] Year to retrieve W2 information for. 4-digit year. Ex. 2015 See GetW2YearList

Example

GET http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/W2InformationDetails/245781227/2014

Return Values

NameDescription
ErrorCode 0000=Success, 0002=No Records
ErrorMessage Message returned with error code
YEEMP# Employee number that was entered
YEW2YEAR W2 Year that was entered
YEW2BOX# Box number on W2 form the value is from
YEW2BOXLTR Box letter on W2 form the value is from
YEW2BOXSEQ Box sequence on W2 form the value is from
YEW2BOXDES Box description on W2 form the value is from
YEW2BOXDTA The value for the given box
YEW2STLCL State or Local indicator

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/W2InformationDetails/245781227/2014";
    WebClient wc = new WebClient();
    wc.Headers.Set("X-APPID", "YOURID");
    wc.Headers.Set("X-APPKEY", "YOURKEY");
    string stringResult = wc.DownloadString(new Uri(uri));
    
    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 YEEMP# = row["YEEMP#"].ToString();
             string YEW2YEAR = row["YEW2YEAR"].ToString();
             string YEW2BOX# = row["YEW2BOX#"].ToString();
             string YEW2BOXLTR = row["YEW2BOXLTR"].ToString();
             string YEW2BOXSEQ = row["YEW2BOXSEQ"].ToString();
             string YEW2BOXDES = row["YEW2BOXDES"].ToString();
             string YEW2BOXDTA = row["YEW2BOXDTA"].ToString();
             string YEW2STLCL = row["YEW2STLCL"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/W2InformationDetails/245781227/2014', 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 GetW2InformationDetails
   {
       // Add property for each input param in order to map a field to it
       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,10}", ErrorMessage = "Numeric values only. Must be 10 digits or less. ")]
       public string employeeNumber{get; set;}

       [Required(ErrorMessage = "Required")]
       [RegularExpression("[0-9]{0,4}", ErrorMessage = "Numeric values only. Must be 4 digits or less. ")]
       public string year{get; set;}

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

@{
   ViewBag.Title = "GetW2InformationDetails";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/W2InformationDetails/245781227/2014";
}

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

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

// 
// POST: /MyController/GetW2InformationDetails
[HttpPost]
public ActionResult GetW2InformationDetails(FormCollection collection)
{
   string url = "v2/Naviline/EmployeeSelfService/W2InformationDetails/245781227/2014";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("employeeNumber", collection["employeeNumber"]);
   inputParms.Add("year", collection["year"]);

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