https://github.com/rsm-hcd/edgate-netcore-api
.NET Standard implementation of an EdGate api client
https://github.com/rsm-hcd/edgate-netcore-api
Last synced: 2 months ago
JSON representation
.NET Standard implementation of an EdGate api client
- Host: GitHub
- URL: https://github.com/rsm-hcd/edgate-netcore-api
- Owner: rsm-hcd
- License: apache-2.0
- Created: 2018-05-21T17:30:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-24T11:45:24.000Z (about 7 years ago)
- Last Synced: 2025-03-24T22:03:11.215Z (2 months ago)
- Language: C#
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EdGate NetCore Api
Dotnet Core Package for connecting to [EdGate's Api](http://correlation.edgate.com/api/docs). This repository is a work in progress, and does not yet encompass all the methods available in the EdGate Api.
## Installation
Install from the Nuget repository https://www.nuget.org/packages/AndcultureCode.EdGate.NetCore.Api/
## Usage
### Getting your profile details
```
var options = new EdGateClientOptions
{
EdGatePublicKey = "Your Api Public Key",
EdGatePrivateKey = "Your Api Private Key"
};
var client = new EdGateClient(options);
var profile = client.Profile.GetProfile();
```
## Interfaces
### IEdGateClient
* `IEdGateProfileClient Profile` - Profile Client
* `IEdGateStandardsClient Standards` - Standards Client
### IEdGateProfileClient
* `Profile GetProfile()` - Get profile details for current account. http://correlation.edgate.com/api/docs/profile
| Parameter | Description |
| ------------- | ------------- |
| no params | |
### IEdGateStandardsClient
* `List ExportStandards(string standardsSetId, string subject = "")` - Export list of standards for a given standards set and optionally a subject. [Api Docs](http://api.edgate.com/navigate/#!/Standards/exportStandards)
| Parameter | Description |
| ------------- | ------------- |
| standardsSetId | Id of the parent standards set to filter by |
| subject | _(optional)_ Subject that the standards must be associated with |
* `List GetStandardsSets()` - Get the list of standards set objects. [Api Docs](http://api.edgate.com/navigate/#!/Standards/findStandardsSets)
| Parameter | Description |
| ------------- | ------------- |
| no params | |
* `List GetStandardsBySet(string standardsSetId, string subject, string grade, bool correlate)` - Get list of standards for a given standards set. [Api Docs](http://api.edgate.com/navigate/#!/Standards/findStandardList)
| Parameter | Description |
| ------------- | ------------- |
| standardsSetId | Id of the parent standards set to filter by |
| subject | Subject that the standards must be associated with |
| grade | Grade that the standards must be associated with |
* `Standard GetStandard(string standardId)` - Get data for an individual standard. [Api Docs](http://api.edgate.com/navigate/#!/Standards/findStandardById)
| Parameter | Description |
| ------------- | ------------- |
| standardsSetId | Id of the parent standards set to filter by |
| subject | Subject that the standards must be associated with |
| grade | Grade that the standards must be associated with |