Skip to content
This repository was archived by the owner on Feb 10, 2025. It is now read-only.

Commit 33b8e04

Browse files
author
Ellucian-SDK-Builder
committed
Ellucian Ethos Integration SDK C# objects documentation commit.
1 parent a7893d1 commit 33b8e04

File tree

12 files changed

+136
-156
lines changed

12 files changed

+136
-156
lines changed

‎Bpapi/Ban/articles/intro.html renamed to ‎Bpapi/Ban/README.html

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
<head>
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8-
<title>Add your introductions here! </title>
8+
<title>Ethos Integration SDK C# Object Library </title>
99
<meta name="viewport" content="width=device-width">
10-
<meta name="title" content="Add your introductions here! ">
10+
<meta name="title" content="Ethos Integration SDK C# Object Library ">
1111
<meta name="generator" content="docfx 2.59.2.0">
1212

13-
<link rel="shortcut icon" href="../favicon.ico">
14-
<link rel="stylesheet" href="../styles/docfx.vendor.css">
15-
<link rel="stylesheet" href="../styles/docfx.css">
16-
<link rel="stylesheet" href="../styles/main.css">
17-
<meta property="docfx:navrel" content="../toc.html">
13+
<link rel="shortcut icon" href="favicon.ico">
14+
<link rel="stylesheet" href="styles/docfx.vendor.css">
15+
<link rel="stylesheet" href="styles/docfx.css">
16+
<link rel="stylesheet" href="styles/main.css">
17+
<meta property="docfx:navrel" content="toc.html">
1818
<meta property="docfx:tocrel" content="toc.html">
1919

2020

@@ -34,8 +34,8 @@
3434
<span class="icon-bar"></span>
3535
</button>
3636

37-
<a class="navbar-brand" href="../index.html">
38-
<img id="logo" class="svg" src="../logo.svg" alt="">
37+
<a class="navbar-brand" href="index.html">
38+
<img id="logo" class="svg" src="logo.svg" alt="">
3939
</a>
4040
</div>
4141
<div class="collapse navbar-collapse" id="navbar">
@@ -57,18 +57,22 @@
5757
</div>
5858
</header>
5959
<div role="main" class="container body-content hide-when-search">
60-
61-
<div class="sidenav hide-when-search">
62-
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
63-
<div class="sidetoggle collapse" id="sidetoggle">
64-
<div id="sidetoc"></div>
65-
</div>
66-
</div>
67-
<div class="article row grid-right">
60+
<div class="article row grid">
6861
<div class="col-md-10">
6962
<article class="content wrap" id="_content" data-uid="">
70-
<h1 id="add-your-introductions-here">Add your introductions here!</h1>
63+
<h1 id="ethos-integration-sdk-c-object-library">Ethos Integration SDK C# Object Library</h1>
7164

65+
<p>This repository contains generated C# objects for use with the Ethos Integration SDK (EISDK) for C#. The code in this repository is not manually maintained, but rather is generated and pushed to this repository. The binaries for this library are available on NuGet.</p>
66+
<p>This contains the C# objects for both the Eedm and Bpapi object libraries.</p>
67+
<p>Following are the instructions on how to add a NuGet package reference in DotNet project:</p>
68+
<ol>
69+
<li>Right click on &quot;Dependencies&quot; under your dotnet project</li>
70+
<li>Then select &quot;Manage NuGet Packages&quot;</li>
71+
<li>Under the browse tab in the search text box type &quot;Ellucian.Generated&quot; and hit enter</li>
72+
<li>The result should have &quot;Ellucian.Generated.Eedm&quot; and &quot;Ellucian.Generated.BpApi.Ban&quot; libraries</li>
73+
<li>You can then select each library by selecting in the result window and clicking on the &quot;Install&quot; button in the right pane of the result window</li>
74+
</ol>
75+
<p>Once installed you are ready to explore various objects and use them in your project.</p>
7276
</article>
7377
</div>
7478

@@ -101,8 +105,8 @@ <h5>In This Article</h5>
101105
</footer>
102106
</div>
103107

104-
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
105-
<script type="text/javascript" src="../styles/docfx.js"></script>
106-
<script type="text/javascript" src="../styles/main.js"></script>
108+
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
109+
<script type="text/javascript" src="styles/docfx.js"></script>
110+
<script type="text/javascript" src="styles/main.js"></script>
107111
</body>
108112
</html>

‎Bpapi/Ban/api/index.html

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
<head>
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8-
<title>PLACEHOLDER </title>
8+
<title>Ethos Integration SDK C# Object Library </title>
99
<meta name="viewport" content="width=device-width">
10-
<meta name="title" content="PLACEHOLDER ">
10+
<meta name="title" content="Ethos Integration SDK C# Object Library ">
1111
<meta name="generator" content="docfx 2.59.2.0">
1212

1313
<link rel="shortcut icon" href="../favicon.ico">
@@ -67,9 +67,19 @@
6767
<div class="article row grid-right">
6868
<div class="col-md-10">
6969
<article class="content wrap" id="_content" data-uid="">
70-
<h1 id="placeholder">PLACEHOLDER</h1>
70+
<h1 id="ethos-integration-sdk-c-object-library">Ethos Integration SDK C# Object Library</h1>
7171

72-
<p>TODO: Add .NET projects to the <em>src</em> folder and run <code>docfx</code> to generate <strong>REAL</strong> <em>API Documentation</em>!</p>
72+
<p>This repository contains generated C# objects for use with the Ethos Integration SDK (EISDK) for C#. The code in this repository is not manually maintained, but rather is generated and pushed to this repository. The binaries for this library are available on NuGet.</p>
73+
<p>This contains the C# objects for both the Eedm and Bpapi object libraries.</p>
74+
<p>Following are the instructions on how to add a NuGet package reference in DotNet project:</p>
75+
<ol>
76+
<li>Right click on &quot;Dependencies&quot; under your dotnet project</li>
77+
<li>Then select &quot;Manage NuGet Packages&quot;</li>
78+
<li>Under the browse tab in the search text box type &quot;Ellucian.Generated&quot; and hit enter</li>
79+
<li>The result should have &quot;Ellucian.Generated.Eedm&quot; and &quot;Ellucian.Generated.BpApi.Ban&quot; libraries</li>
80+
<li>You can then select each library by selecting in the result window and clicking on the &quot;Install&quot; button in the right pane of the result window</li>
81+
</ol>
82+
<p>Once installed you are ready to explore various objects and use them in your project.</p>
7383
</article>
7484
</div>
7585

‎Bpapi/Ban/articles/toc.html

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎Bpapi/Ban/index.html

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,17 @@
6262
<article class="content wrap" id="_content" data-uid="">
6363
<h1 id="ethos-integration-sdk-c-object-library">Ethos Integration SDK C# Object Library</h1>
6464

65-
<p>This repository contains generated C# objects for use with the Ethos Integration SDK (EISDK) for C#. This code in this respository is not manually maintained, but rather is generated and pushed to this repository. The binaries for this library are available on NuGet.</p>
66-
<p>This contains the C# objects for the Banner Bpapi object library.</p>
65+
<p>This repository contains generated C# objects for use with the Ethos Integration SDK (EISDK) for C#. The code in this repository is not manually maintained, but rather is generated and pushed to this repository. The binaries for this library are available on NuGet.</p>
66+
<p>This contains the C# objects for both the Eedm and Bpapi object libraries.</p>
67+
<p>Following are the instructions on how to add a NuGet package reference in DotNet project:</p>
68+
<ol>
69+
<li>Right click on &quot;Dependencies&quot; under your dotnet project</li>
70+
<li>Then select &quot;Manage NuGet Packages&quot;</li>
71+
<li>Under the browse tab in the search text box type &quot;Ellucian.Generated&quot; and hit enter</li>
72+
<li>The result should have &quot;Ellucian.Generated.Eedm&quot; and &quot;Ellucian.Generated.BpApi.Ban&quot; libraries</li>
73+
<li>You can then select each library by selecting in the result window and clicking on the &quot;Install&quot; button in the right pane of the result window</li>
74+
</ol>
75+
<p>Once installed you are ready to explore various objects and use them in your project.</p>
6776
</article>
6877
</div>
6978

‎Bpapi/Ban/manifest.json

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
"source_base_path": "/var/lib/jenkins/workspace/EthosDataModel/EISDK-Object-Generation-and-Publication-Pipeline/4-Generate-CSharp-Objects/devexp-object-generator-eicsdk/EllucianGeneratedBpapiBan",
44
"xrefmap": "xrefmap.yml",
55
"files": [
6+
{
7+
"type": "Conceptual",
8+
"source_relative_path": "README.md",
9+
"output": {
10+
".html": {
11+
"relative_path": "README.html",
12+
"hash": "CpM0qi8yBq+1nZOolox2XAre1yLDjnSXkJz0Cn9ZvzU="
13+
}
14+
},
15+
"is_incremental": false,
16+
"version": ""
17+
},
618
{
719
"type": "ManagedReference",
820
"source_relative_path": "api/Ellucian.Generated.BpApi.Ban.AFIFundSourceCodes100GetRequest.AFIFundSourceCodes100GetRequest.yml",
@@ -107313,7 +107325,7 @@
107313107325
"output": {
107314107326
".html": {
107315107327
"relative_path": "api/index.html",
107316-
"hash": "S6HH25ziEUKWJk9c1SDkf4tv9pt+s1Em+CanR3D4XJQ="
107328+
"hash": "G02WXkXmlHk1mru6wwTlMIiqbK4ABhPOYJJ745mP8jM="
107317107329
}
107318107330
},
107319107331
"is_incremental": false,
@@ -107331,37 +107343,13 @@
107331107343
"is_incremental": false,
107332107344
"version": ""
107333107345
},
107334-
{
107335-
"type": "Conceptual",
107336-
"source_relative_path": "articles/intro.md",
107337-
"output": {
107338-
".html": {
107339-
"relative_path": "articles/intro.html",
107340-
"hash": "aOy2sep6UZV26oOkupcIBXuDgHQsCVz7R3i+I6vFl6Y="
107341-
}
107342-
},
107343-
"is_incremental": false,
107344-
"version": ""
107345-
},
107346-
{
107347-
"type": "Toc",
107348-
"source_relative_path": "articles/toc.yml",
107349-
"output": {
107350-
".html": {
107351-
"relative_path": "articles/toc.html",
107352-
"hash": "BlPxk5mtl2kgfcZUgkEguqiSAR/EUyUTT4EdebwkQvs="
107353-
}
107354-
},
107355-
"is_incremental": false,
107356-
"version": ""
107357-
},
107358107346
{
107359107347
"type": "Conceptual",
107360107348
"source_relative_path": "index.md",
107361107349
"output": {
107362107350
".html": {
107363107351
"relative_path": "index.html",
107364-
"hash": "VcgTOT28/4O3B5VzFGC6+RXd9OYLrCSMwmBiXz/Dzhc="
107352+
"hash": "oNiFwIJN4BvS4/sHVTsdTsPG+Pl1P9svjWLQEFcFTiI="
107365107353
}
107366107354
},
107367107355
"is_incremental": false,
@@ -107373,7 +107361,7 @@
107373107361
"output": {
107374107362
".html": {
107375107363
"relative_path": "toc.html",
107376-
"hash": "WSuRrYiGwKKMbtdG9z8W9fXmLoCyTnGg9AxbPKLXm2Y="
107364+
"hash": "s+UecGKJLe11K3w4+MJjx6QoiqktkO8teeQG06lk8L0="
107377107365
}
107378107366
},
107379107367
"is_incremental": false,

‎Bpapi/Ban/toc.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010
</div>
1111
<div class="sidetoc">
1212
<div class="toc" id="toc">
13+
1314
<ul class="nav level1">
1415
<li>
15-
<a href="api/Ellucian.Generated.BpApi.Ban.html" name="api/toc.html" title="Api Documentation">Api Documentation</a>
16+
<a href="api/index.html" name="api/toc.html" title="Api Documentation">Api Documentation</a>
1617
</li>
1718
</ul>
1819
</div>
1920
</div>
2021
</div>
21-
</div>
22+
</div>

‎Eedm/articles/intro.html renamed to ‎Eedm/README.html

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
<head>
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8-
<title>Add your introductions here! </title>
8+
<title>Ethos Integration SDK C# Object Library </title>
99
<meta name="viewport" content="width=device-width">
10-
<meta name="title" content="Add your introductions here! ">
10+
<meta name="title" content="Ethos Integration SDK C# Object Library ">
1111
<meta name="generator" content="docfx 2.59.2.0">
1212

13-
<link rel="shortcut icon" href="../favicon.ico">
14-
<link rel="stylesheet" href="../styles/docfx.vendor.css">
15-
<link rel="stylesheet" href="../styles/docfx.css">
16-
<link rel="stylesheet" href="../styles/main.css">
17-
<meta property="docfx:navrel" content="../toc.html">
13+
<link rel="shortcut icon" href="favicon.ico">
14+
<link rel="stylesheet" href="styles/docfx.vendor.css">
15+
<link rel="stylesheet" href="styles/docfx.css">
16+
<link rel="stylesheet" href="styles/main.css">
17+
<meta property="docfx:navrel" content="toc.html">
1818
<meta property="docfx:tocrel" content="toc.html">
1919

2020

@@ -34,8 +34,8 @@
3434
<span class="icon-bar"></span>
3535
</button>
3636

37-
<a class="navbar-brand" href="../index.html">
38-
<img id="logo" class="svg" src="../logo.svg" alt="">
37+
<a class="navbar-brand" href="index.html">
38+
<img id="logo" class="svg" src="logo.svg" alt="">
3939
</a>
4040
</div>
4141
<div class="collapse navbar-collapse" id="navbar">
@@ -57,18 +57,22 @@
5757
</div>
5858
</header>
5959
<div role="main" class="container body-content hide-when-search">
60-
61-
<div class="sidenav hide-when-search">
62-
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
63-
<div class="sidetoggle collapse" id="sidetoggle">
64-
<div id="sidetoc"></div>
65-
</div>
66-
</div>
67-
<div class="article row grid-right">
60+
<div class="article row grid">
6861
<div class="col-md-10">
6962
<article class="content wrap" id="_content" data-uid="">
70-
<h1 id="add-your-introductions-here">Add your introductions here!</h1>
63+
<h1 id="ethos-integration-sdk-c-object-library">Ethos Integration SDK C# Object Library</h1>
7164

65+
<p>This repository contains generated C# objects for use with the Ethos Integration SDK (EISDK) for C#. The code in this repository is not manually maintained, but rather is generated and pushed to this repository. The binaries for this library are available on NuGet.</p>
66+
<p>This contains the C# objects for both the Eedm and Bpapi object libraries.</p>
67+
<p>Following are the instructions on how to add a NuGet package reference in DotNet project:</p>
68+
<ol>
69+
<li>Right click on &quot;Dependencies&quot; under your dotnet project</li>
70+
<li>Then select &quot;Manage NuGet Packages&quot;</li>
71+
<li>Under the browse tab in the search text box type &quot;Ellucian.Generated&quot; and hit enter</li>
72+
<li>The result should have &quot;Ellucian.Generated.Eedm&quot; and &quot;Ellucian.Generated.BpApi.Ban&quot; libraries</li>
73+
<li>You can then select each library by selecting in the result window and clicking on the &quot;Install&quot; button in the right pane of the result window</li>
74+
</ol>
75+
<p>Once installed you are ready to explore various objects and use them in your project.</p>
7276
</article>
7377
</div>
7478

@@ -101,8 +105,8 @@ <h5>In This Article</h5>
101105
</footer>
102106
</div>
103107

104-
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
105-
<script type="text/javascript" src="../styles/docfx.js"></script>
106-
<script type="text/javascript" src="../styles/main.js"></script>
108+
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
109+
<script type="text/javascript" src="styles/docfx.js"></script>
110+
<script type="text/javascript" src="styles/main.js"></script>
107111
</body>
108112
</html>

‎Eedm/api/index.html

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
<head>
66
<meta charset="utf-8">
77
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8-
<title>PLACEHOLDER </title>
8+
<title>Ethos Integration SDK C# Object Library </title>
99
<meta name="viewport" content="width=device-width">
10-
<meta name="title" content="PLACEHOLDER ">
10+
<meta name="title" content="Ethos Integration SDK C# Object Library ">
1111
<meta name="generator" content="docfx 2.59.2.0">
1212

1313
<link rel="shortcut icon" href="../favicon.ico">
@@ -67,9 +67,19 @@
6767
<div class="article row grid-right">
6868
<div class="col-md-10">
6969
<article class="content wrap" id="_content" data-uid="">
70-
<h1 id="placeholder">PLACEHOLDER</h1>
70+
<h1 id="ethos-integration-sdk-c-object-library">Ethos Integration SDK C# Object Library</h1>
7171

72-
<p>TODO: Add .NET projects to the <em>src</em> folder and run <code>docfx</code> to generate <strong>REAL</strong> <em>API Documentation</em>!</p>
72+
<p>This repository contains generated C# objects for use with the Ethos Integration SDK (EISDK) for C#. The code in this repository is not manually maintained, but rather is generated and pushed to this repository. The binaries for this library are available on NuGet.</p>
73+
<p>This contains the C# objects for both the Eedm and Bpapi object libraries.</p>
74+
<p>Following are the instructions on how to add a NuGet package reference in DotNet project:</p>
75+
<ol>
76+
<li>Right click on &quot;Dependencies&quot; under your dotnet project</li>
77+
<li>Then select &quot;Manage NuGet Packages&quot;</li>
78+
<li>Under the browse tab in the search text box type &quot;Ellucian.Generated&quot; and hit enter</li>
79+
<li>The result should have &quot;Ellucian.Generated.Eedm&quot; and &quot;Ellucian.Generated.BpApi.Ban&quot; libraries</li>
80+
<li>You can then select each library by selecting in the result window and clicking on the &quot;Install&quot; button in the right pane of the result window</li>
81+
</ol>
82+
<p>Once installed you are ready to explore various objects and use them in your project.</p>
7383
</article>
7484
</div>
7585

‎Eedm/articles/toc.html

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)