Class CmdsDocumentsController

Namespace

InSite.Api.Controllers

Assembly

InSite.UI.dll

This assignment of a specific profile, competency, or achievement to a specific learner is a document. Use the requests in this folder to query for things like assigned profiles, self-assessed competencies, validated competencies, granted achievements, and expired achievements.

[RoutePrefix("api/cmds/documents")]
public class CmdsDocumentsController : ApiBaseController, IHttpController, IDisposable

Inheritance

object

ApiController

ApiBaseController

CmdsDocumentsController

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

CmdsDocumentsController()

public CmdsDocumentsController()

Methods

Achievements(string, string)

[HttpGet]
[Route("achievements")]
public HttpResponseMessage Achievements(string achievement = null, string learner = null)

Parameters

achievement string

learner string

Returns

HttpResponseMessage

Remarks

Use this request to query for a listing of the achievements assigned to learners in your organization.

Competencies(string, string)

[HttpGet]
[Route("competencies")]
public HttpResponseMessage Competencies(string competency = null, string learner = null)

Parameters

competency string

learner string

Returns

HttpResponseMessage

Remarks

Use this request to query for a listing of the competencies assigned to learners in your organization.

Profiles(string, string)

[HttpGet]
[Route("profiles")]
public HttpResponseMessage Profiles(string profile = null, string learner = null)

Parameters

profile string

learner string

Returns

HttpResponseMessage

Remarks

Use this request to query for a listing of the profiles assigned to learners in your organization.