Method PutPEPhoneDetail

Type: FusionOSServices.Controllers.PEPhoneDetailController

Summary

REST service that provides an interface to update the PEPhoneDetail table

Example

PUT https://fusion.centralsquare.com/FusionOSServices/v2/ONESolution/PersonEntity/PEPhoneDetail/00000001/01/BL

Parameters

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

Sample Code

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

public void MethodName(parms){
    string ID = "00000001", phoneCd = "01", addrCd = "BL";
    string uri = $"https://fusion.superion.com/FusionOSServices/v2/ONESolution/PersonEntity/PEPhoneDetail/{ID}/{phoneCd}/{addrCd}";
    string data = 
    @"[{
          ""peId"": ""00000001"",
          ""phoneTypeCd"": ""01"",
          ""phoneNumber"": ""8541258945"",
          ""phoneExtension"": """",
          ""createWho"": ""NAYANAT~1"",
          ""createWhen"": ""6/16/2010 9:48:24 PM"",
          ""updateWho"": ""RESTAPI"",
          ""updateWhen"": ""9/28/2020 9:38:51 PM"",
          ""uniqueKey"": ""03BF3DE0-1BD7-4C52-9430-CA262EB9939E"",
          ""addrCd"": ""BL"",
          ""phoneCountryCd"": """"
    }]";

    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");

        string result = wc.UploadString(uri, "PUT", data);

        JObject response;
        if (!string.IsNullOrWhiteSpace(result))
             response = JObject.Parse(result);
    }
}

Remarks

The first logical directory after /PEPhoneDetail is the PE ID. After that, the next directory is the phone code, followed by the address code. All must be specified. Alternatively, the uniqueKey of a single record may be specified in the query string immediately after /PEPhoneDetail, as in ".../PEPhoneDetail?uniqueKey=jey899S". If a corresponding record exists, that record will be updated with the data in the request body. The body must contain the same key field information as the URL. The JSON body can be copied from a GET and altered as needed. Errors are returned as JSON objects with messages in the #text attribute, e.g.: { "#text": "Cannot find Record to update" }