ballerinax/ellucian.student Ballerina library

1.0.0

This is a generated connector for Ellucian Student v16.0.0 OpenAPI specification. Ellucian is a higher education platform connecting people, processes and applications across the institution to power coordinated programs designed for student success. Ellucian Students API provides capability to retrieve details about students recorded in Colleague.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Ellucian Student connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/ellucian.student module into the Ballerina project.

Copy
import ballerinax/ellucian.student;

Step 2: Create a new connector instance

Create a student:ClientConfig with the token obtained, and initialize the connector with it.

Copy
student:ClientConfig clientConfig = {auth:{token: "XXXXXXX"}};
student:Client baseClient = check new (clientConfig);

You can also specify and override the default service URL as below.

Copy
student:Client baseClient = check new (clientConfig, "<SERVICE_URL>");

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on getting all student resources.

    Get all Students

    Copy
    public function main() returns error? {
        student:Student response = check baseClient->getStudents();
        log:printInfo(response.toString());
    }
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/ellucian.student;Copy

Metadata

Released date: over 1 year ago

Version: 1.0.0

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.1.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 1


Weekly downloads


Source repository


Keywords

Education/Student Services
Cost/Paid

Contributors

Other versions

1.0.0