Method GetPERecords

Type: FusionOSServices.Controllers.PersonEntityController

Summary

This service returns Person Entity Information including some feilds about address, phone and email.

Example

GET https://fusion.superion.com/FusionOSServices/v0/ONESolution/PersonEntity/PEMaster

Sample Code

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

public void MethodName(parms){

    string uri = "https://fusion.superion.com/FusionOSServices/v0/ONESolution/PersonEntity/PEMaster";

    using (WebClient wc = new WebClient())
    {
        wc.Headers.Add("Content-Type", "application/json");
        // Replace "ID" with supplied AppID
        wc.Headers.Set("X-APPID", "ID");
        // Replace "KEY" with supplied AppKey
        wc.Headers.Set("X-APPKEY", "KEY");

        while (uri != null)
        {
            string result = wc.DownloadString(uri);

            var response = JObject.Parse(result);

            var count = (string)response["RequestResponse"]["Count"];
            var personEntityResponse = (JContainer)response["RequestResponse"]["DATA"];

            // responses with more then 1000 person entity are broken up into multiple requests
            nextUri = (string)response["RequestResponse"]["NextUri"];
        }
    }
}

Sample Responses


                        
                    {
              "RequestResponse": {
                "Count": "1",
                "DATA": {
                  "peNameMaster": [
                    {
                      "peId": "00002188",
                      "name": "Smith, Donald",
                      "idStatus": "AC",
                      "securityCd": "CD",
                      "dba": "Donald Smith",
                      "peAddrDetail": [
                        {
                          "addrCd": "HO",
                          "addr1": "Home office",
                          "addr2": "updated 2/27/2024",
                          "addr3": "",
                          "addr4": "",
                          "zip": "",
                          "city": "",
                          "stateCd": "",
                          "addrAttn": ""
                        }
                      ],
                      "pePhoneDetail": [
                        {
                          "phoneTypeCd": "HO",
                          "phoneNumber": "6598798796",
                          "phoneExtension": ""
                        }
                      ],
                      "peEmailDetail": [
                        {
                          "emailTypeCd": "OF",
                          "addrCd": "PM",
                          "emailAddr": "Donald.Smith@gmail.com"
                        }
                      ]
                    }
                  ]
                }
              }
            }
             
        

Remarks

Query string options SkipRows: The number of rows at the begining of the query to not report. TakeRows: The number of rows from the query to report. If left blank the default is 1000. ?TakeRows=10 results in only 10 rows being returned. ?SkipRows=10 results in all rows after row 10 being returned. ?SkipRows=10&TakeRows=10 results in rows 11 through 20 being returned. Filters: "?peid=Dan" will select Person Entity with PeId Dan. "?status=AC" will select Person Entities who are Active. "?updateWhen=1/1/2017+gt" will include all dates after 1/1/2017. For "UpdateWhen", default comparison is equality. Other comparison are available and can be appended to the filter Available comparisons are: "ge", greater than or equal to (>=) "gt", greater than (>) "le", less than or equal to (<=) "lt", less than (<)