Method GetDependentInformation

Summary

Get Employee Dependent Information

Remarks

Returns a row for each dependent the employee has declared

Input Parameters

NameTypeLengthDescription
userNumber numeric 10 [Required] User Number. May need to be padded left with zeros to make it 10 digits.
userPIN numeric 10 [Required] User Number. May need to be padded left with zeros to make it 10 digits.
rows numeric 4 [Required] Number of rows to return. Used with paging
pageNumber numeric 5 [Required] Page number to return. Used with paging

Example

GET http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/DependentInformation/{userNumber}/{userPIN}/{rows}/{pageNumber}

Return Values

NameDescription
ErrorCode 0000=Success, 0001=Not found, 0003=No Dependents
ErrorMessage Message returned with error code
LastName Last name of dependent
FirstName First name of dependent
MiddleInitial Middle Initial of dependent
BirthdayYear Year dependent was born
BirthdayMonth Month dependent was born
BirthdayDay Day dependent was born
Address1 Address line 1 of dependent if different than employee's address
Address2 Address line 2 of dependent if different than employee's address
City City of dependent if different than employee's address
State State of dependent if different than employee's address
ZipCode Zip Code of dependent if different than employee's address
AreaCode Area Code of dependent if different than employee's address
PhoneNumber Phone Number of dependent if different than employee's address
Sex Sex of dependent. M/F
Student Is dependent a student. Y/N
RelationshipCode Relationship code
RelationshipDescription Relationship description
DODY Date of Dependency Year
DODM Date of Dependency Month
DODD Date of Dependency Day
DSTS Dependency Status
PRK507 Employee's userNumber
SSN Social Security Number
D577 Dependent record ID
Status

Sample Responses

Sample Code

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

public void MethodName(parms)
{
    string uri = "http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/DependentInformation/0000000008/0000000008/0030/00001";
    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 LastName = row["LastName"].ToString();
             string FirstName = row["FirstName"].ToString();
             string MiddleInitial = row["MiddleInitial"].ToString();
             string BirthdayYear = row["BirthdayYear"].ToString();
             string BirthdayMonth = row["BirthdayMonth"].ToString();
             string BirthdayDay = row["BirthdayDay"].ToString();
             string Address1 = row["Address1"].ToString();
             string Address2 = row["Address2"].ToString();
             string City = row["City"].ToString();
             string State = row["State"].ToString();
             string ZipCode = row["ZipCode"].ToString();
             string AreaCode = row["AreaCode"].ToString();
             string PhoneNumber = row["PhoneNumber"].ToString();
             string Sex = row["Sex"].ToString();
             string Student = row["Student"].ToString();
             string RelationshipCode = row["RelationshipCode"].ToString();
             string RelationshipDescription = row["RelationshipDescription"].ToString();
             string DODY = row["DODY"].ToString();
             string DODM = row["DODM"].ToString();
             string DODD = row["DODD"].ToString();
             string DSTS = row["DSTS"].ToString();
             string PRK507 = row["PRK507"].ToString();
             string SSN = row["SSN"].ToString();
             string D577 = row["D577"].ToString();
             string Status = row["Status"].ToString();
             // TODO - YOUR CODE HERE
        }
    }
}

$.get('http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/DependentInformation/0000000008/0000000008/0030/00001', 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 GetDependentInformation
   {
       // 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 userNumber{get; set;}

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

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

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

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

@{
   ViewBag.Title = "GetDependentInformation";
   string myUrl = "http://localhost/FusionServices/v2/Naviline/EmployeeSelfService/DependentInformation/" + Model.userNumber + "/" + Model.userPIN + "/" + Model.rows + "/" + Model.pageNumber;
}

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

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

// 
// POST: /MyController/GetDependentInformation
[HttpPost]
public ActionResult GetDependentInformation(FormCollection collection)
{
   string url = "v2/Naviline/EmployeeSelfService/DependentInformation/{userNumber}/{userPIN}/{rows}/{pageNumber}";
   // Get the value from each input field
   NameValueCollection inputParms = new NameValueCollection();
   inputParms.Add("userNumber", collection["userNumber"]);
   inputParms.Add("userPIN", collection["userPIN"]);
   inputParms.Add("rows", collection["rows"]);
   inputParms.Add("pageNumber", collection["pageNumber"]);

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