GET restapi/personal/course/{courseId}/assessmentrecord/settings/v1
Setup for the assessment record page, language, settings, paths, and permissions
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| courseId |
The identifier of a course to get assessment record setup from. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Itslearning.RestApi.Entities.Personal.Course.PageSetup.AssessmentRecordSetup| Name | Description | Type | Additional information |
|---|---|---|---|
| Language |
Language for the assessment record page. |
Itslearning.RestApi.Entities.Personal.Course.PageSetup.AssessmentRecordLanguage |
None. |
| Paths |
Paths for the assessment record page. |
Itslearning.RestApi.Entities.Personal.Course.PageSetup.AssessmentRecordPaths |
None. |
| Settings |
Settings for the assessment record page. |
Itslearning.RestApi.Entities.Personal.Course.PageSetup.AssessmentRecordSettings |
None. |
| Permissions |
Gets or sets the permissions for the assessment record page. |
Itslearning.RestApi.Entities.Personal.Course.PageSetup.AssessmentRecordPermissions |
None. |
Response Formats
application/json, text/json
Sample:
{
"Language": {
"AddAssessment": "sample string 1",
"AddCategories": "sample string 2",
"AddGroups": "sample string 3",
"AddToGradebook": "sample string 4",
"AllAssessments": "sample string 5",
"AllGroups": "sample string 6",
"AllParticipants": "sample string 7",
"AnErrorOccurred": "sample string 8",
"Apply": "sample string 9",
"Assess": "sample string 10",
"AssessmentRecordCategory": "sample string 11",
"AssessmentRecordSettings": "sample string 12",
"AssessmentWeight": "sample string 13",
"AssessmentWeighting": "sample string 14",
"AverageAndCount": "sample string 15",
"Cancel": "sample string 16",
"CannotDeleteFinalAssessment": "sample string 17",
"Categories": "sample string 18",
"CategoryExistsButNotInUseMessage": "sample string 19",
"CategoryWeight": "sample string 20",
"CategoryWeighting": "sample string 21",
"Close": "sample string 22",
"ColumnsNotConnectedToTerms": "sample string 23",
"CompleteTerm": "sample string 24",
"CompletedTermMessage": "sample string 25",
"Confirm": "sample string 26",
"Deadline": "sample string 27",
"Delete": "sample string 28",
"Dismiss": "sample string 29",
"Edit": "sample string 30",
"ErrorDuringPageLoad": "sample string 31",
"ErrorMessage": "sample string 32",
"Ex": "sample string 33",
"Exempt": "sample string 34",
"ExistingAssessment": "sample string 35",
"ExportToCsv": "sample string 36",
"FilterBy": "sample string 37",
"FinalAssessment": "sample string 38",
"Functions": "sample string 39",
"Grade": "sample string 40",
"GradebookGroup": "sample string 41",
"Groups": "sample string 42",
"Information": "sample string 43",
"MoreOptions": "sample string 44",
"Name": "sample string 45",
"NewGradebookColumn": "sample string 46",
"NoAssessmentWeighting": "sample string 47",
"NoCategories": "sample string 48",
"NoCategoriesCreatedMessage": "sample string 49",
"NoGrading": "sample string 50",
"NoGroups": "sample string 51",
"NoGroupsCreatedMessage": "sample string 52",
"NoMoreExistingAssessments": "sample string 53",
"NoParticipantsAvailable": "sample string 54",
"NoStudentsMatchSearch": "sample string 55",
"LearningPathWarning": "sample string 56",
"NSlashA": "sample string 57",
"Options": "sample string 58",
"OverallAverage": "sample string 59",
"Overdue": "sample string 60",
"PageTitle": "sample string 61",
"ParticipantsNotInAGroup": "sample string 62",
"Percent": "sample string 63",
"PleaseConfirm": "sample string 64",
"Points": "sample string 65",
"Refresh": "sample string 66",
"Retry": "sample string 67",
"RevertExemption": "sample string 68",
"Score": "sample string 69",
"Search": "sample string 70",
"SearchStudents": "sample string 71",
"Sort": "sample string 72",
"Summary": "sample string 73",
"SubmissionLink": "sample string 74",
"Term": "sample string 75",
"Title": "sample string 76",
"TransferTo": "sample string 77",
"TrendsAndProgress": "sample string 78",
"UnableToExempt": "sample string 79",
"UnableToOverwrite": "sample string 80",
"UnableToSetGrade": "sample string 81",
"UnableToSetScore": "sample string 82",
"Uncategorised": "sample string 83",
"ValidationNumberBetween": "sample string 84",
"View": "sample string 85",
"ViewInExcel": "sample string 86",
"WarningForCompletingTerm": "sample string 87",
"WarningForDeletingElement": "sample string 88",
"NotAvailable": "sample string 89"
},
"Paths": {
"StaticContent": "sample string 1"
},
"Settings": {
"ExtensionModules": [
{
"ModuleExtensionSetupId": 1,
"Title": "sample string 2",
"OpenInNewWindow": true
},
{
"ModuleExtensionSetupId": 1,
"Title": "sample string 2",
"OpenInNewWindow": true
}
],
"Categories": [
{
"CategoryId": 1,
"Title": "sample string 2",
"Weight": 3.1,
"Position": 4.1
},
{
"CategoryId": 1,
"Title": "sample string 2",
"Weight": 3.1,
"Position": 4.1
}
],
"DefaultProfilePicture": "sample string 1",
"DefaultProfilePictureSmall": "sample string 2",
"AssessmentRecordIcon": "sample string 3",
"ExternalSystemName": "sample string 4",
"ExtraUserInformation": "sample string 5",
"Groups": [
{
"GroupId": 1,
"Title": "sample string 2"
},
{
"GroupId": 1,
"Title": "sample string 2"
}
],
"HasExistingAssessment": true,
"IsAccessibilityModeEnabled": true,
"IsAssessmentRecordEnabledForCourse": true,
"IsAssessmentRecordSettingsLinkVisible": true,
"IsAverageAndCountEnabled": true,
"IsCategoryWeightingEnabled": true,
"IsExemptEnabled": true,
"IsSummaryEnabled": true,
"IsTransferToExternalSystemEnabled": true,
"LastUsedCategoryIds": [
1,
2
],
"LocaleDecimalSeparator": "sample string 15",
"NameFormat": 0,
"ShowOverallAverage": true,
"SelectedCategoryIds": [
1,
2
],
"SelectedGroupIds": [
1,
2
],
"SelectedScoreFormatId": 17,
"SelectedSortOptionId": 18,
"SelectedTermId": 19,
"Terms": [
{
"TermId": 1,
"Title": "sample string 2",
"Status": 3,
"IsCompleted": true,
"CompletedDate": "sample string 5",
"CompletedBy": "sample string 6",
"IsDeleted": true
},
{
"TermId": 1,
"Title": "sample string 2",
"Status": 3,
"IsCompleted": true,
"CompletedDate": "sample string 5",
"CompletedBy": "sample string 6",
"IsDeleted": true
}
],
"UseAssessmentWeighting": true,
"UserName": "sample string 21",
"UseScorePointsForAverage": true
},
"Permissions": {
"HasGeneralAdministrationPermission": true
}
}
application/xml, text/xml
Sample:
<AssessmentRecordSetup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Personal.Course.PageSetup">
<Language>
<AddAssessment>sample string 1</AddAssessment>
<AddCategories>sample string 2</AddCategories>
<AddGroups>sample string 3</AddGroups>
<AddToGradebook>sample string 4</AddToGradebook>
<AllAssessments>sample string 5</AllAssessments>
<AllGroups>sample string 6</AllGroups>
<AllParticipants>sample string 7</AllParticipants>
<AnErrorOccurred>sample string 8</AnErrorOccurred>
<Apply>sample string 9</Apply>
<Assess>sample string 10</Assess>
<AssessmentRecordCategory>sample string 11</AssessmentRecordCategory>
<AssessmentRecordSettings>sample string 12</AssessmentRecordSettings>
<AssessmentWeight>sample string 13</AssessmentWeight>
<AssessmentWeighting>sample string 14</AssessmentWeighting>
<AverageAndCount>sample string 15</AverageAndCount>
<Cancel>sample string 16</Cancel>
<CannotDeleteFinalAssessment>sample string 17</CannotDeleteFinalAssessment>
<Categories>sample string 18</Categories>
<CategoryExistsButNotInUseMessage>sample string 19</CategoryExistsButNotInUseMessage>
<CategoryWeight>sample string 20</CategoryWeight>
<CategoryWeighting>sample string 21</CategoryWeighting>
<Close>sample string 22</Close>
<ColumnsNotConnectedToTerms>sample string 23</ColumnsNotConnectedToTerms>
<CompleteTerm>sample string 24</CompleteTerm>
<CompletedTermMessage>sample string 25</CompletedTermMessage>
<Confirm>sample string 26</Confirm>
<Deadline>sample string 27</Deadline>
<Delete>sample string 28</Delete>
<Dismiss>sample string 29</Dismiss>
<Edit>sample string 30</Edit>
<ErrorDuringPageLoad>sample string 31</ErrorDuringPageLoad>
<ErrorMessage>sample string 32</ErrorMessage>
<Ex>sample string 33</Ex>
<Exempt>sample string 34</Exempt>
<ExistingAssessment>sample string 35</ExistingAssessment>
<ExportToCsv>sample string 36</ExportToCsv>
<FilterBy>sample string 37</FilterBy>
<FinalAssessment>sample string 38</FinalAssessment>
<Functions>sample string 39</Functions>
<Grade>sample string 40</Grade>
<GradebookGroup>sample string 41</GradebookGroup>
<Groups>sample string 42</Groups>
<Information>sample string 43</Information>
<LearningPathWarning>sample string 56</LearningPathWarning>
<MoreOptions>sample string 44</MoreOptions>
<NSlashA>sample string 57</NSlashA>
<Name>sample string 45</Name>
<NewGradebookColumn>sample string 46</NewGradebookColumn>
<NoAssessmentWeighting>sample string 47</NoAssessmentWeighting>
<NoCategories>sample string 48</NoCategories>
<NoCategoriesCreatedMessage>sample string 49</NoCategoriesCreatedMessage>
<NoGrading>sample string 50</NoGrading>
<NoGroups>sample string 51</NoGroups>
<NoGroupsCreatedMessage>sample string 52</NoGroupsCreatedMessage>
<NoMoreExistingAssessments>sample string 53</NoMoreExistingAssessments>
<NoParticipantsAvailable>sample string 54</NoParticipantsAvailable>
<NoStudentsMatchSearch>sample string 55</NoStudentsMatchSearch>
<NotAvailable>sample string 89</NotAvailable>
<Options>sample string 58</Options>
<OverallAverage>sample string 59</OverallAverage>
<Overdue>sample string 60</Overdue>
<PageTitle>sample string 61</PageTitle>
<ParticipantsNotInAGroup>sample string 62</ParticipantsNotInAGroup>
<Percent>sample string 63</Percent>
<PleaseConfirm>sample string 64</PleaseConfirm>
<Points>sample string 65</Points>
<Refresh>sample string 66</Refresh>
<Retry>sample string 67</Retry>
<RevertExemption>sample string 68</RevertExemption>
<Score>sample string 69</Score>
<Search>sample string 70</Search>
<SearchStudents>sample string 71</SearchStudents>
<Sort>sample string 72</Sort>
<SubmissionLink>sample string 74</SubmissionLink>
<Summary>sample string 73</Summary>
<Term>sample string 75</Term>
<Title>sample string 76</Title>
<TransferTo>sample string 77</TransferTo>
<TrendsAndProgress>sample string 78</TrendsAndProgress>
<UnableToExempt>sample string 79</UnableToExempt>
<UnableToOverwrite>sample string 80</UnableToOverwrite>
<UnableToSetGrade>sample string 81</UnableToSetGrade>
<UnableToSetScore>sample string 82</UnableToSetScore>
<Uncategorised>sample string 83</Uncategorised>
<ValidationNumberBetween>sample string 84</ValidationNumberBetween>
<View>sample string 85</View>
<ViewInExcel>sample string 86</ViewInExcel>
<WarningForCompletingTerm>sample string 87</WarningForCompletingTerm>
<WarningForDeletingElement>sample string 88</WarningForDeletingElement>
</Language>
<Paths>
<StaticContent>sample string 1</StaticContent>
</Paths>
<Permissions>
<HasGeneralAdministrationPermission>true</HasGeneralAdministrationPermission>
</Permissions>
<Settings>
<AssessmentRecordIcon>sample string 3</AssessmentRecordIcon>
<Categories>
<AssessmentRecordCategory xmlns="">
<CategoryId>1</CategoryId>
<Position>4.1</Position>
<Title>sample string 2</Title>
<Weight>3.1</Weight>
</AssessmentRecordCategory>
<AssessmentRecordCategory xmlns="">
<CategoryId>1</CategoryId>
<Position>4.1</Position>
<Title>sample string 2</Title>
<Weight>3.1</Weight>
</AssessmentRecordCategory>
</Categories>
<DefaultProfilePicture>sample string 1</DefaultProfilePicture>
<DefaultProfilePictureSmall>sample string 2</DefaultProfilePictureSmall>
<ExtensionModules>
<ExtensionModuleModel>
<ModuleExtensionSetupId>1</ModuleExtensionSetupId>
<Title>sample string 2</Title>
</ExtensionModuleModel>
<ExtensionModuleModel>
<ModuleExtensionSetupId>1</ModuleExtensionSetupId>
<Title>sample string 2</Title>
</ExtensionModuleModel>
</ExtensionModules>
<ExternalSystemName>sample string 4</ExternalSystemName>
<ExtraUserInformation>sample string 5</ExtraUserInformation>
<Groups>
<AssessmentRecordGroup xmlns="">
<GroupId>1</GroupId>
<Title>sample string 2</Title>
</AssessmentRecordGroup>
<AssessmentRecordGroup xmlns="">
<GroupId>1</GroupId>
<Title>sample string 2</Title>
</AssessmentRecordGroup>
</Groups>
<HasExistingAssessment>true</HasExistingAssessment>
<IsAccessibilityModeEnabled>true</IsAccessibilityModeEnabled>
<IsAssessmentRecordEnabledForCourse>true</IsAssessmentRecordEnabledForCourse>
<IsAssessmentRecordSettingsLinkVisible>true</IsAssessmentRecordSettingsLinkVisible>
<IsAverageAndCountEnabled>true</IsAverageAndCountEnabled>
<IsCategoryWeightingEnabled>true</IsCategoryWeightingEnabled>
<IsExemptEnabled>true</IsExemptEnabled>
<IsSummaryEnabled>true</IsSummaryEnabled>
<IsTransferToExternalSystemEnabled>true</IsTransferToExternalSystemEnabled>
<LastUsedCategoryIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</LastUsedCategoryIds>
<LocaleDecimalSeparator>sample string 15</LocaleDecimalSeparator>
<NameFormat>LastFirst</NameFormat>
<SelectedCategoryIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</SelectedCategoryIds>
<SelectedGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</SelectedGroupIds>
<SelectedScoreFormatId>17</SelectedScoreFormatId>
<SelectedSortOptionId>18</SelectedSortOptionId>
<SelectedTermId>19</SelectedTermId>
<ShowOverallAverage>true</ShowOverallAverage>
<Terms>
<AssessmentRecordTerm xmlns="">
<CompletedBy>sample string 6</CompletedBy>
<CompletedDate>sample string 5</CompletedDate>
<IsCompleted>true</IsCompleted>
<IsDeleted>true</IsDeleted>
<Status>3</Status>
<TermId>1</TermId>
<Title>sample string 2</Title>
</AssessmentRecordTerm>
<AssessmentRecordTerm xmlns="">
<CompletedBy>sample string 6</CompletedBy>
<CompletedDate>sample string 5</CompletedDate>
<IsCompleted>true</IsCompleted>
<IsDeleted>true</IsDeleted>
<Status>3</Status>
<TermId>1</TermId>
<Title>sample string 2</Title>
</AssessmentRecordTerm>
</Terms>
<UseAssessmentWeighting>true</UseAssessmentWeighting>
<UseScorePointsForAverage>true</UseScorePointsForAverage>
<UserName>sample string 21</UserName>
</Settings>
</AssessmentRecordSetup>