GET restapi/personal/courses/{courseId}/participants/setup/v1

Setup for the course participant and add participant page. Language settings and permissions.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
courseId

The course identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Setup for the course participant page

Itslearning.RestApi.Entities.Personal.Course.PageSetup.CourseParticipantSetup
NameDescriptionTypeAdditional information
Language

Language for the course participant page.

Itslearning.RestApi.Entities.Personal.Course.PageSetup.CourseParticipantLanguage

None.

Paths

Paths for the course participant page.

Itslearning.RestApi.Entities.Personal.Course.PageSetup.CourseParticipantPaths

None.

Settings

Settings for the course participant page.

Itslearning.RestApi.Entities.Personal.Course.PageSetup.CourseParticipantSettings

None.

Permissions

Gets or sets the permissions for the course participant page.

Itslearning.RestApi.Entities.Personal.Course.PageSetup.CourseParticipantPermissions

None.

Response Formats

application/json, text/json

Sample:
{
  "Language": {
    "All": "sample string 1",
    "Add": "sample string 2",
    "AddHierarchy": "sample string 3",
    "AddParticipant": "sample string 4",
    "BrowseHierarchies": "sample string 5",
    "BrowseUsers": "sample string 6",
    "Cancel": "sample string 7",
    "ChangeRole": "sample string 8",
    "ChangeRoleFor": "sample string 9",
    "Close": "sample string 10",
    "ConfirmRemoveParticipant": "sample string 11",
    "ConfirmRemoveMultipleParticipants": "sample string 12",
    "CouldNotRemoveParticipant": "sample string 13",
    "CouldNotRemoveMultipleParticipants": "sample string 14",
    "Email": "sample string 15",
    "FilteredParticipantsCount": "sample string 16",
    "Freely": "sample string 17",
    "Hierarchy": "sample string 18",
    "LastVisited": "sample string 19",
    "MaxAllowedInstantMessageRecipientsExceeded": "sample string 20",
    "Name": "sample string 21",
    "NoParticipants": "sample string 22",
    "NoSearchResults": "sample string 23",
    "Ok": "sample string 24",
    "OpenProfileCardFor": "sample string 25",
    "Options": "sample string 26",
    "Participants": "sample string 27",
    "ParticipantsCount": "sample string 28",
    "Password": "sample string 29",
    "Unenrolled": "sample string 30",
    "Remove": "sample string 31",
    "RemoveParticipantsConfirmation": "sample string 32",
    "Role": "sample string 33",
    "Save": "sample string 34",
    "Search": "sample string 35",
    "SelectAll": "sample string 36",
    "SelectUsersFrom": "sample string 37",
    "SendMessage": "sample string 38",
    "Registration": "sample string 39",
    "Tasks": "sample string 40",
    "User": "sample string 41",
    "Users": "sample string 42",
    "AddParticipantsEmptyState": "sample string 43",
    "SynchronizedHierarchiesEmptyState": "sample string 44",
    "UnerolledParticipantsEmptyState": "sample string 45",
    "ApplicantsEmptyState": "sample string 46",
    "Applicants": "sample string 47",
    "ApplicationState": "sample string 48",
    "Approve": "sample string 49",
    "Reject": "sample string 50",
    "Accepted": "sample string 51",
    "Pending": "sample string 52",
    "Rejected": "sample string 53",
    "NoApplicants": "sample string 54",
    "CourseGroups": "sample string 55",
    "DateUnenrolled": "sample string 56",
    "TemporaryAccess": "sample string 57",
    "Assessment": "sample string 58",
    "SendMessageToolTip": "sample string 59"
  },
  "Paths": {
    "StaticContent": "sample string 1",
    "EmptyStateImage": "sample string 2"
  },
  "Settings": {
    "CourseProfiles": [
      {
        "CourseProfileId": 1,
        "Title": "sample string 2",
        "ExistsInCourse": true,
        "CanBeUsedForAddingParticipantsToCourse": true
      },
      {
        "CourseProfileId": 1,
        "Title": "sample string 2",
        "ExistsInCourse": true,
        "CanBeUsedForAddingParticipantsToCourse": true
      }
    ],
    "DefaultCourseProfileId": 1,
    "InstantMessageMaxPersonsPerThread": 2,
    "ShowApplicantTab": true,
    "FirstNameFirst": true,
    "ExtraInformationTitle": "sample string 5",
    "FunctionalityMessages": true,
    "CurrentPersonId": 7,
    "TemporaryAccessToCourses": true
  },
  "Permissions": {
    "HasManageParticipantsAndGroupsPermission": true,
    "HasGeneralAdministrationPermission": true,
    "CanViewDetailedInformation": true
  }
}

application/xml, text/xml

Sample:
<CourseParticipantSetup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Personal.Course.PageSetup">
  <Language>
    <Accepted>sample string 51</Accepted>
    <Add>sample string 2</Add>
    <AddHierarchy>sample string 3</AddHierarchy>
    <AddParticipant>sample string 4</AddParticipant>
    <AddParticipantsEmptyState>sample string 43</AddParticipantsEmptyState>
    <All>sample string 1</All>
    <Applicants>sample string 47</Applicants>
    <ApplicantsEmptyState>sample string 46</ApplicantsEmptyState>
    <ApplicationState>sample string 48</ApplicationState>
    <Approve>sample string 49</Approve>
    <Assessment>sample string 58</Assessment>
    <BrowseHierarchies>sample string 5</BrowseHierarchies>
    <BrowseUsers>sample string 6</BrowseUsers>
    <Cancel>sample string 7</Cancel>
    <ChangeRole>sample string 8</ChangeRole>
    <ChangeRoleFor>sample string 9</ChangeRoleFor>
    <Close>sample string 10</Close>
    <ConfirmRemoveMultipleParticipants>sample string 12</ConfirmRemoveMultipleParticipants>
    <ConfirmRemoveParticipant>sample string 11</ConfirmRemoveParticipant>
    <CouldNotRemoveMultipleParticipants>sample string 14</CouldNotRemoveMultipleParticipants>
    <CouldNotRemoveParticipant>sample string 13</CouldNotRemoveParticipant>
    <CourseGroups>sample string 55</CourseGroups>
    <DateUnenrolled>sample string 56</DateUnenrolled>
    <Email>sample string 15</Email>
    <FilteredParticipantsCount>sample string 16</FilteredParticipantsCount>
    <Freely>sample string 17</Freely>
    <Hierarchy>sample string 18</Hierarchy>
    <LastVisited>sample string 19</LastVisited>
    <MaxAllowedInstantMessageRecipientsExceeded>sample string 20</MaxAllowedInstantMessageRecipientsExceeded>
    <Name>sample string 21</Name>
    <NoApplicants>sample string 54</NoApplicants>
    <NoParticipants>sample string 22</NoParticipants>
    <NoSearchResults>sample string 23</NoSearchResults>
    <Ok>sample string 24</Ok>
    <OpenProfileCardFor>sample string 25</OpenProfileCardFor>
    <Options>sample string 26</Options>
    <Participants>sample string 27</Participants>
    <ParticipantsCount>sample string 28</ParticipantsCount>
    <Password>sample string 29</Password>
    <Pending>sample string 52</Pending>
    <Registration>sample string 39</Registration>
    <Reject>sample string 50</Reject>
    <Rejected>sample string 53</Rejected>
    <Remove>sample string 31</Remove>
    <RemoveParticipantsConfirmation>sample string 32</RemoveParticipantsConfirmation>
    <Role>sample string 33</Role>
    <Save>sample string 34</Save>
    <Search>sample string 35</Search>
    <SelectAll>sample string 36</SelectAll>
    <SelectUsersFrom>sample string 37</SelectUsersFrom>
    <SendMessage>sample string 38</SendMessage>
    <SendMessageToolTip>sample string 59</SendMessageToolTip>
    <SynchronizedHierarchiesEmptyState>sample string 44</SynchronizedHierarchiesEmptyState>
    <Tasks>sample string 40</Tasks>
    <TemporaryAccess>sample string 57</TemporaryAccess>
    <Unenrolled>sample string 30</Unenrolled>
    <UnerolledParticipantsEmptyState>sample string 45</UnerolledParticipantsEmptyState>
    <User>sample string 41</User>
    <Users>sample string 42</Users>
  </Language>
  <Paths>
    <EmptyStateImage>sample string 2</EmptyStateImage>
    <StaticContent>sample string 1</StaticContent>
  </Paths>
  <Permissions>
    <CanViewDetailedInformation>true</CanViewDetailedInformation>
    <HasGeneralAdministrationPermission>true</HasGeneralAdministrationPermission>
    <HasManageParticipantsAndGroupsPermission>true</HasManageParticipantsAndGroupsPermission>
  </Permissions>
  <Settings>
    <CourseProfiles>
      <CourseProfile>
        <CanBeUsedForAddingParticipantsToCourse>true</CanBeUsedForAddingParticipantsToCourse>
        <CourseProfileId>1</CourseProfileId>
        <ExistsInCourse>true</ExistsInCourse>
        <Title>sample string 2</Title>
      </CourseProfile>
      <CourseProfile>
        <CanBeUsedForAddingParticipantsToCourse>true</CanBeUsedForAddingParticipantsToCourse>
        <CourseProfileId>1</CourseProfileId>
        <ExistsInCourse>true</ExistsInCourse>
        <Title>sample string 2</Title>
      </CourseProfile>
    </CourseProfiles>
    <CurrentPersonId>7</CurrentPersonId>
    <DefaultCourseProfileId>1</DefaultCourseProfileId>
    <ExtraInformationTitle>sample string 5</ExtraInformationTitle>
    <FirstNameFirst>true</FirstNameFirst>
    <FunctionalityMessages>true</FunctionalityMessages>
    <InstantMessageMaxPersonsPerThread>2</InstantMessageMaxPersonsPerThread>
    <ShowApplicantTab>true</ShowApplicantTab>
    <TemporaryAccessToCourses>true</TemporaryAccessToCourses>
  </Settings>
</CourseParticipantSetup>