GET restapi/personal/courses/{courseId}/addparticipants/search/v1?searchText={searchText}

Search for persons to add to a course.

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The course identifier.	integer	Required
searchText	A phrase to search for	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of persons that can be added to the course. Will not contain users already added

EntityListOfItslearning.RestApi.Entities.PersonSimple

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.PersonSimple	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "ProfileUrl": "sample string 5",
      "AdditionalInfo": "sample string 6",
      "ProfileImageUrl": "sample string 7",
      "ProfileImageUrlSmall": "sample string 8"
    },
    {
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "ProfileUrl": "sample string 5",
      "AdditionalInfo": "sample string 6",
      "ProfileImageUrl": "sample string 7",
      "ProfileImageUrlSmall": "sample string 8"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <PersonSimple>
      <AdditionalInfo>sample string 6</AdditionalInfo>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 4</FullName>
      <LastName>sample string 3</LastName>
      <PersonId>1</PersonId>
      <ProfileImageUrl>sample string 7</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
      <ProfileUrl>sample string 5</ProfileUrl>
    </PersonSimple>
    <PersonSimple>
      <AdditionalInfo>sample string 6</AdditionalInfo>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 4</FullName>
      <LastName>sample string 3</LastName>
      <PersonId>1</PersonId>
      <ProfileImageUrl>sample string 7</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
      <ProfileUrl>sample string 5</ProfileUrl>
    </PersonSimple>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>