Loading...

API Endpoint: References

The Wisenet References Endpoint allows your applications to get predefined and dynamic references lists.

Reference Entity Properties

The standard set of fields for the Reference entity is

  • Code
  • Description

But for particular references some fields can be missing, e.g. NoKRelationship has Descriptions only.

List particular Reference

GET /references/{reference}

Here {reference} is the Reference Name, can be

  • cortargetgroup
  • nokrelationship
  • statusreason
  • clienttargetgroup
  • workplaceclassification
  • result

Example: List CORTargetGroup Reference

GET /references/cortargetgroup

Returns the list of CORTargetGroup Reference. Used in Course Offer Enrolments objects.

Sample request:

 curl -X GET \
   -H "Accept: application/json" \
   https://tst-api.wisenet.co/references/cortargetgroup

Sample response:

  { "SetCount":6,
    "ReferenceValues":[
      {"Description":"target group client reg offer"},
      {"Description":"Off Shore"},
      {"Description":"On Shore"},
      {"Description":"International Off Shore"},
      {"Description":"International On Shore"},
      {"Description":"Domestic"}
    ]
  }

C# Code Sample

public static void GetSample()
{
    const string url = "https://tst-api.wisenet.co/references/cortargetgroup";

    var request = HttpWebRequest.Create(url) as HttpWebRequest;
    request.Accept = "application/json";
    request.Method = "GET";
    request.UserAgent = "C# Sample Client";

    try
    {
        // Get response  
        using (var response = request.GetResponse() as HttpWebResponse)
        {
            // Get the response stream  
            using (var responseReader = new StreamReader(response.GetResponseStream()))
            {
                string responseBody = responseReader.ReadToEnd();

                // Console application output  
                Console.WriteLine(responseBody);
            }
        }
    }
    catch (WebException ex)
    {
        Console.WriteLine("Error: {0}", ex.Message);
    }
}

Was this Resource helpful?