GET api/StudyMaterial/GetStudyMatrialList?InstituteYearId={InstituteYearId}&StudentId={StudentId}&FolderId={FolderId}&AppVersion={AppVersion}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| InstituteYearId | string |
Required |
|
| StudentId | string |
Required |
|
| FolderId | string |
Required |
|
| AppVersion | string |
Required |
Body Parameters
None.
Response Information
Resource Description
StudyMaterialListObject| Name | Description | Type | Additional information |
|---|---|---|---|
| response | string |
None. |
|
| Title | string |
None. |
|
| message | string |
None. |
|
| parentId | string |
None. |
|
| folderList | Collection of FolderDetails |
None. |
|
| fileList | Collection of FileDetails |
None. |
Response Formats
application/json, text/json
Sample:
{
"response": "sample string 1",
"Title": "sample string 2",
"message": "sample string 3",
"parentId": "sample string 4",
"folderList": [
{
"id": "sample string 1",
"name": "sample string 2"
},
{
"id": "sample string 1",
"name": "sample string 2"
}
],
"fileList": [
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"url": "sample string 4",
"dateTime": "sample string 5",
"sName": "sample string 6"
},
{
"id": "sample string 1",
"name": "sample string 2",
"type": "sample string 3",
"url": "sample string 4",
"dateTime": "sample string 5",
"sName": "sample string 6"
}
]
}
text/html
Sample:
{"response":"sample string 1","Title":"sample string 2","message":"sample string 3","parentId":"sample string 4","folderList":[{"id":"sample string 1","name":"sample string 2"},{"id":"sample string 1","name":"sample string 2"}],"fileList":[{"id":"sample string 1","name":"sample string 2","type":"sample string 3","url":"sample string 4","dateTime":"sample string 5","sName":"sample string 6"},{"id":"sample string 1","name":"sample string 2","type":"sample string 3","url":"sample string 4","dateTime":"sample string 5","sName":"sample string 6"}]}
application/xml, text/xml
Sample:
<StudyMaterialModels.StudyMaterialListObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
<Title>sample string 2</Title>
<fileList>
<StudyMaterialModels.FileDetails>
<dateTime>sample string 5</dateTime>
<id>sample string 1</id>
<name>sample string 2</name>
<sName>sample string 6</sName>
<type>sample string 3</type>
<url>sample string 4</url>
</StudyMaterialModels.FileDetails>
<StudyMaterialModels.FileDetails>
<dateTime>sample string 5</dateTime>
<id>sample string 1</id>
<name>sample string 2</name>
<sName>sample string 6</sName>
<type>sample string 3</type>
<url>sample string 4</url>
</StudyMaterialModels.FileDetails>
</fileList>
<folderList>
<StudyMaterialModels.FolderDetails>
<id>sample string 1</id>
<name>sample string 2</name>
</StudyMaterialModels.FolderDetails>
<StudyMaterialModels.FolderDetails>
<id>sample string 1</id>
<name>sample string 2</name>
</StudyMaterialModels.FolderDetails>
</folderList>
<message>sample string 3</message>
<parentId>sample string 4</parentId>
<response>sample string 1</response>
</StudyMaterialModels.StudyMaterialListObject>