GET v{version}/offeringbase
Retrieves all offering bases along with their associated offerings.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of OfferingBaseViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OfferingBaseId | integer |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| Category | string |
None. |
|
| CategoryId | integer |
None. |
|
| DepartmentId | integer |
None. |
|
| Department | string |
None. |
|
| SubjectName | string |
None. |
|
| SubjectId | integer |
None. |
|
| SubjectAreaName | string |
None. |
|
| SubjectAreaId | integer |
None. |
|
| TeacherIds | Collection of integer |
None. |
|
| Image | BlobViewModel |
None. |
|
| Offerings | Collection of OfferingViewModel |
None. |
|
| Attributes | Collection of IAttribute |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"OfferingBaseId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"Category": "sample string 4",
"CategoryId": 1,
"DepartmentId": 5,
"Department": "sample string 6",
"SubjectName": "sample string 7",
"SubjectId": 1,
"SubjectAreaName": "sample string 8",
"SubjectAreaId": 1,
"TeacherIds": [
1,
2
],
"Image": {
"BlobId": "sample string 1",
"Name": "sample string 2",
"MimeType": "sample string 3",
"Size": 4,
"Extention": "sample string 5",
"UniqueId": 158727831
},
"Offerings": [
{
"OfferingId": 1,
"OfferingBaseId": 2,
"PublicName": "sample string 3",
"IsOngoing": true,
"IsEnsemble": true
},
{
"OfferingId": 1,
"OfferingBaseId": 2,
"PublicName": "sample string 3",
"IsOngoing": true,
"IsEnsemble": true
}
],
"Attributes": null
},
{
"OfferingBaseId": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"Category": "sample string 4",
"CategoryId": 1,
"DepartmentId": 5,
"Department": "sample string 6",
"SubjectName": "sample string 7",
"SubjectId": 1,
"SubjectAreaName": "sample string 8",
"SubjectAreaId": 1,
"TeacherIds": [
1,
2
],
"Image": {
"BlobId": "sample string 1",
"Name": "sample string 2",
"MimeType": "sample string 3",
"Size": 4,
"Extention": "sample string 5",
"UniqueId": 158727831
},
"Offerings": [
{
"OfferingId": 1,
"OfferingBaseId": 2,
"PublicName": "sample string 3",
"IsOngoing": true,
"IsEnsemble": true
},
{
"OfferingId": 1,
"OfferingBaseId": 2,
"PublicName": "sample string 3",
"IsOngoing": true,
"IsEnsemble": true
}
],
"Attributes": null
}
]
application/xml, text/xml
Sample:
<ArrayOfOfferingBaseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels">
<OfferingBaseViewModel>
<Category>sample string 4</Category>
<CategoryId>1</CategoryId>
<Department>sample string 6</Department>
<DepartmentId>5</DepartmentId>
<Description>sample string 3</Description>
<Image />
<Name>sample string 2</Name>
<OfferingBaseId>1</OfferingBaseId>
<Offerings>
<OfferingViewModel>
<IsEnsemble>true</IsEnsemble>
<IsOngoing>true</IsOngoing>
<OfferingBaseId>2</OfferingBaseId>
<OfferingId>1</OfferingId>
<PublicName>sample string 3</PublicName>
</OfferingViewModel>
<OfferingViewModel>
<IsEnsemble>true</IsEnsemble>
<IsOngoing>true</IsOngoing>
<OfferingBaseId>2</OfferingBaseId>
<OfferingId>1</OfferingId>
<PublicName>sample string 3</PublicName>
</OfferingViewModel>
</Offerings>
<SubjectAreaId>1</SubjectAreaId>
<SubjectAreaName>sample string 8</SubjectAreaName>
<SubjectId>1</SubjectId>
<SubjectName>sample string 7</SubjectName>
<TeacherIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</TeacherIds>
</OfferingBaseViewModel>
<OfferingBaseViewModel>
<Category>sample string 4</Category>
<CategoryId>1</CategoryId>
<Department>sample string 6</Department>
<DepartmentId>5</DepartmentId>
<Description>sample string 3</Description>
<Image />
<Name>sample string 2</Name>
<OfferingBaseId>1</OfferingBaseId>
<Offerings>
<OfferingViewModel>
<IsEnsemble>true</IsEnsemble>
<IsOngoing>true</IsOngoing>
<OfferingBaseId>2</OfferingBaseId>
<OfferingId>1</OfferingId>
<PublicName>sample string 3</PublicName>
</OfferingViewModel>
<OfferingViewModel>
<IsEnsemble>true</IsEnsemble>
<IsOngoing>true</IsOngoing>
<OfferingBaseId>2</OfferingBaseId>
<OfferingId>1</OfferingId>
<PublicName>sample string 3</PublicName>
</OfferingViewModel>
</Offerings>
<SubjectAreaId>1</SubjectAreaId>
<SubjectAreaName>sample string 8</SubjectAreaName>
<SubjectId>1</SubjectId>
<SubjectName>sample string 7</SubjectName>
<TeacherIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</TeacherIds>
</OfferingBaseViewModel>
</ArrayOfOfferingBaseViewModel>