GET restapi/personal/courses/cards/{courseId}/settings/v1

Gets the course card settings

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The course Id	integer	Required

Body Parameters

None.

Response Information

Resource Description

This method returns the course card settings .

Itslearning.RestApi.Entities.CourseCardSettings

Name	Description	Type	Additional information
CourseTitle	Course title.	string	None.
FriendlyName	Friendly course name.	string	None.
CourseColorClass	Course colour.	string	None.
VisibleCourseCardCandidateIds	Teacher representatives id's, comma separated	string	None.
VisibleCourseCardCandidates	Teacher representatives	Collection of Itslearning.RestApi.Entities.CourseCardTeacher	None.
CourseCardImageFileRepoId	The ID of course card image in the FileRepo.	globally unique identifier	None.
CourseCardImageUrl	Signed FileRepo URL of course card image which is used to display image on the user interface.	string	None.
CourseCardImageSignedFileRepoId	Signed FileRepo URL of course card image which is used to check the validation when uploading a new image.	string	None.
CanEditCourseColour	True if person can change the colour	boolean	None.
CanEditFriendlyName	True if person can change the friendly name	boolean	None.
CourseCardImageDescription	Image description for course card	string	None.
SaveImageToYourImagesForEasyReuse	Defines whether newly uploaded course card image should be saved into media repository to be reused in "Your images" tab later.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CourseTitle": "sample string 1",
  "FriendlyName": "sample string 2",
  "CourseColorClass": "sample string 3",
  "VisibleCourseCardCandidateIds": "sample string 4",
  "VisibleCourseCardCandidates": [
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "ProfileUrl": "sample string 3",
      "IsVisibleOnCourseCard": true
    },
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "ProfileUrl": "sample string 3",
      "IsVisibleOnCourseCard": true
    }
  ],
  "CourseCardImageFileRepoId": "9361e0d6-fa55-4967-adca-b833f205999b",
  "CourseCardImageUrl": "sample string 6",
  "CourseCardImageSignedFileRepoId": "sample string 7",
  "CanEditCourseColour": true,
  "CanEditFriendlyName": true,
  "CourseCardImageDescription": "sample string 10",
  "SaveImageToYourImagesForEasyReuse": true
}

application/xml, text/xml

Sample:

<CourseCardSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CanEditCourseColour>true</CanEditCourseColour>
  <CanEditFriendlyName>true</CanEditFriendlyName>
  <CourseCardImageDescription>sample string 10</CourseCardImageDescription>
  <CourseCardImageFileRepoId>9361e0d6-fa55-4967-adca-b833f205999b</CourseCardImageFileRepoId>
  <CourseCardImageSignedFileRepoId>sample string 7</CourseCardImageSignedFileRepoId>
  <CourseCardImageUrl>sample string 6</CourseCardImageUrl>
  <CourseColorClass>sample string 3</CourseColorClass>
  <CourseTitle>sample string 1</CourseTitle>
  <FriendlyName>sample string 2</FriendlyName>
  <SaveImageToYourImagesForEasyReuse>true</SaveImageToYourImagesForEasyReuse>
  <VisibleCourseCardCandidateIds>sample string 4</VisibleCourseCardCandidateIds>
  <VisibleCourseCardCandidates>
    <CourseCardTeacher>
      <FullName>sample string 2</FullName>
      <IsVisibleOnCourseCard>true</IsVisibleOnCourseCard>
      <PersonId>1</PersonId>
      <ProfileUrl>sample string 3</ProfileUrl>
    </CourseCardTeacher>
    <CourseCardTeacher>
      <FullName>sample string 2</FullName>
      <IsVisibleOnCourseCard>true</IsVisibleOnCourseCard>
      <PersonId>1</PersonId>
      <ProfileUrl>sample string 3</ProfileUrl>
    </CourseCardTeacher>
  </VisibleCourseCardCandidates>
</CourseCardSettings>