WiseNET API - References Endpoint

From Wisenet Resource Centre
Jump to: navigation, search


This page is a part of WiseNET API: Developer Resources.

The Wise.NET References endpoint allows your applications to get predefined and dynamic references lists.

Contents

Related Endpoints

Reference Entity Properties

The standard set of fields for the Reference entity is

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

Example: List CORTargetGroup Reference

GET /references/cortargetgroup

Returns the list of CORTargetGroup Reference. Used in CourseIn Wise.NET a course is usually a qualification or short 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 ClientIn Wise.NET a client is a student, trainee or apprentice";
 
    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);
    }
}
Personal tools
Namespaces
Variants
Actions
Navigation
Translate
Wisenet Getting Started
Learning Relationship Management
Learner App
Trainer Portal
Wise.NET Portal
CRM
eLearning
Surveys
Finance
Application Integration
Compliance: Australia
Compliance: New Zealand
Developer Resources
Toolbox