README

Ellucian Elevate API 的 API 包装器

许可证

有关更多信息，请参阅许可证文件

目的

这是一个简单的包装器，用于访问 Ellucian Elevate API。

用法

新客户端

获取新客户端很简单。

<?php

use ElevateAPI\Client as ElevateClient; // using use to change the name of the client class.

/* the arguments for the Elevate Client are 
   - the URL before the "solar.qll_web" endpoint
   - the auth key 
   - the security type for accessing the system. */
$client = new ElevateClient('http://example.com', 'auth_key', 'key');

// OR - Less code
$client = new ElevateAPI\Client(/** args here **/);

查询 API

您使用 Elevate API 进行每个查询都必须使用该特定查询的查询包装器提交。

例如，如果您尝试访问公共 API 端点，您将创建 ElevateAPI\Query\Common 类的新实例

$query = new Elevate\Query\Common();

// You set the Parameters using setParam();
$query->setParam('serviceCode', 'ONLINE_REG');

// Pass the query to $client->get(); and the result is a SimpleXMLElement object with your data.
$result = $client->get($query);

可用的查询端点

所有目前记录的查询端点都已编码，包括公共和 Ping。

tylerjuniorcollege / elevate-api

维护者

详细信息

README

许可证

目的

用法

新客户端

查询 API

可用的查询端点