ballerinax/ellucian.student Ballerina library

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:

• Create a Ellucian Account.
• Obtain tokens by following this guide.

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.

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.

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

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

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

   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.