Method GetPEAddrDetail

Type: FusionOSServices.Controllers.PEAddrDetailController

Summary

REST service that provides an interface to read the PEAddrDetail table

Example

GET https://fusion.centralsquare.com/FusionOSServices/v2/ONESolution/PersonEntity/PEAddrDetail/00000001/BL

Parameters

TypeDescription
System.String the employee ID
System.String the address code

Sample Code

using System.Net;

public void MethodName(parms){
    string uri = "https://fusion.centralsquare.com/FusionOSServices/v2/ONESolution/PersonEntity/PEAddrDetail/00000001/BL";
    WebClient wc = new WebClient();
    Common.SetResponseType(wc, "json");
    Common.SetLicenseKey(wc);
    string stringResult = wc.DownloadString(new Uri(uri));
    
    JObject response = JObject.Parse(stringResult);
    foreach(var addressRec in response["RequestResponse"]["DATA"]["PEADDRDETAIL"])
    {
       // TODO
    }
}

$.get('https://fusion.centralsquare.com/FusionOSServices/v2/ONESolution/PersonEntity/PEAddrDetail/00000001/BL', function(response) {
    $('#resultDiv).html(response); 
 });

Sample Responses


                        
            {
              "RequestResponse": {
                "Count": "1",
                "DATA": {
                  "PEADDRDETAIL": [
                    {
                      "peId": "00000001",
                      "addr1": "555 Billing Address",
                      "addr2": "",
                      "addr3": "",
                      "addr4": "",
                      "city": "CHICO",
                      "stateCd": "CA",
                      "zip": "95973",
                      "countryCd": "",
                      "url": "",
                      "addrCd": "BL",
                      "uniqueKey": "030A7C42-84B8-43EB-A021-2FDC92571B04",
                      "address1Pc": "",
                      "address2Pc": "",
                      "address3Pc": "",
                      "address4Pc": "",
                      "cityPc": "",
                      "cassStatusCd": "",
                      "cassDt": "",
                      "postalLot": "",
                      "postalMvCd": "",
                      "postalMvDt": "",
                      "carrierRte": "",
                      "carrierType": "",
                      "deliveryPt": "",
                      "addressStatCd": "",
                      "contactId": "",
                      "createWho": "RACHEL.STORN",
                      "createWhen": "2/8/2013 10:26:06 AM",
                      "updateWho": "RACHEL.STORN",
                      "updateWhen": "2/8/2013 10:26:06 AM",
                      "addrAttn": "",
                      "locationLat": "0.000000",
                      "locationLong": "0.000000"
                    }
                  ]
                }
              }
            }
            
        

Remarks

The first logical directory after /PEAddrDetail is the PE ID. After that, the next directory is the address code. If both are specified, and a corresponding record exists, that record will be returned in the PEADDRDETAIL array of size 1 (see below). If the address code is left off the URL, then all records for that PE ID will be returned in the array. Errors are returned as JSON objects with messages in the #text attribute, e.g.: { "#text": "No ID found in path" }