Class LearnersController

Namespace

InSite.Api.Controllers

Assembly

InSite.UI.dll

[RoutePrefix("api/learners")]
public class LearnersController : ApiBaseController, IHttpController, IDisposable

Inheritance

object

ApiController

ApiBaseController

LearnersController

Implements

IHttpController

IDisposable

Inherited Members

ApiBaseController.GetOrganization()

ApiBaseController.JsonBadRequest(object)

ApiBaseController.JsonError(object, HttpStatusCode)

ApiBaseController.JsonSuccess(object, HttpStatusCode)

ApiBaseController.JsonUnauthorized(object, HttpStatusCode)

ApiBaseController.DefaultJsonError(HttpRequestMessage, object, HttpStatusCode)

ApiBaseController.DefaultJsonSuccess(HttpRequestMessage, object, HttpStatusCode)

ApiBaseController.DefaultRedirect(HttpRequestMessage, string, HttpStatusCode)

ApiBaseController.DefaultStringSuccess(HttpRequestMessage, string, HttpStatusCode)

ApiBaseController.Redirect(string, HttpStatusCode)

ApiBaseController.SetupCommandIdentity<TCommand>(TCommand)

ApiBaseController.SendCommand(ICommand)

ApiBaseController.StringSuccess(string, HttpStatusCode)

ApiBaseController.CurrentOrganization

ApiBaseController.CurrentUser

ApiBaseController.IsAdministrator

ApiController.ExecuteAsync(HttpControllerContext, CancellationToken)

ApiController.Validate<TEntity>(TEntity)

ApiController.Validate<TEntity>(TEntity, string)

ApiController.BadRequest()

ApiController.BadRequest(string)

ApiController.BadRequest(ModelStateDictionary)

ApiController.Conflict()

ApiController.Content<T>(HttpStatusCode, T)

ApiController.Content<T>(HttpStatusCode, T, MediaTypeFormatter)

ApiController.Content<T>(HttpStatusCode, T, MediaTypeFormatter, string)

ApiController.Content<T>(HttpStatusCode, T, MediaTypeFormatter, MediaTypeHeaderValue)

ApiController.Created<T>(string, T)

ApiController.Created<T>(Uri, T)

ApiController.CreatedAtRoute<T>(string, object, T)

ApiController.CreatedAtRoute<T>(string, IDictionary<string, object>, T)

ApiController.InternalServerError()

ApiController.InternalServerError(Exception)

ApiController.Json<T>(T)

ApiController.Json<T>(T, JsonSerializerSettings)

ApiController.Json<T>(T, JsonSerializerSettings, Encoding)

ApiController.NotFound()

ApiController.Ok()

ApiController.Ok<T>(T)

ApiController.Redirect(string)

ApiController.Redirect(Uri)

ApiController.RedirectToRoute(string, object)

ApiController.RedirectToRoute(string, IDictionary<string, object>)

ApiController.ResponseMessage(HttpResponseMessage)

ApiController.StatusCode(HttpStatusCode)

ApiController.Unauthorized(params AuthenticationHeaderValue[])

ApiController.Unauthorized(IEnumerable<AuthenticationHeaderValue>)

ApiController.Initialize(HttpControllerContext)

ApiController.Dispose()

ApiController.Dispose(bool)

ApiController.Configuration

ApiController.ControllerContext

ApiController.ActionContext

ApiController.ModelState

ApiController.Request

ApiController.RequestContext

ApiController.Url

ApiController.User

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

LearnersController()

public LearnersController()

Methods

Count(LearnerCriteria)

[HttpPost]
[Route("count")]
[Route("{id}/count")]
public HttpResponseMessage Count(LearnerCriteria criteria)

Parameters

criteria LearnerCriteria

Returns

HttpResponseMessage

Remarks

Counts the learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.

Get()

[HttpGet]
[Route("")]
public HttpResponseMessage Get()

Returns

HttpResponseMessage

Remarks

Returns a list of all people in your organization, including names, email addresses, and home addresses.

Get(string)

[HttpGet]
[Route("{id}")]
public HttpResponseMessage Get(string id)

Parameters

id string

Returns

HttpResponseMessage

Remarks

Returns a person using the person's unique globally unique identifier or individual account code. Account codes are alphanumeric values assigned by your organization.

Save(Learner)

[HttpPost]
[Route("save")]
[Route("{id}/save")]
public HttpResponseMessage Save(Learner learner)

Parameters

learner Learner

Returns

HttpResponseMessage

Remarks

Updates the person's name, email address, and home address. If the person is not in the database, then this method adds them as a new person.

Search(LearnerCriteria)

[HttpPost]
[Route("search")]
[Route("{id}/search")]
public HttpResponseMessage Search(LearnerCriteria criteria)

Parameters

criteria LearnerCriteria

Returns

HttpResponseMessage

Remarks

Searches for learners who match your search criteria. You can search based on any of the following property values: Code, Email, FirstName, and/or LastName.