README

Ed-Fi ODS / API 允许应用程序通过安全的 REST 接口读取和写入存储在 Ed-Fi ODS 中的教育数据。

注意：ODS / API 信息的使用者应对所有数据进行清理以供显示和存储。ODS / API 提供了合理的安全保障以防止跨站脚本攻击和其他恶意内容，但平台不能也不能保证其包含的数据不包含所有潜在的有害内容。

安装 & 使用

要求

PHP 7.3 及更高版本。也应与 PHP 8.0 一起使用，但尚未进行测试。

Composer

要使用 Composer 安装绑定，请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门

请遵循安装过程，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: oauth2_client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AbsenceEventCategoryDescriptorsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 'id_example'; // string | A resource identifier that uniquely identifies the resource.
$if_match = 'if_match_example'; // string | The ETag header value used to prevent the DELETE from removing a resource modified by another consumer.

try {
    $apiInstance->deleteAbsenceEventCategoryDescriptorById($id, $if_match);
} catch (Exception $e) {
    echo 'Exception when calling AbsenceEventCategoryDescriptorsApi->deleteAbsenceEventCategoryDescriptorById: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都是相对于 https://api.ed-fi.org:443/v7.1/api/data/v3

edfi / descriptors

维护者

详细信息

README

安装 & 使用

要求

Composer

手动安装

入门

API 端点

模型