Provides overall API system functionality.
Inheritance Hierarchy
ApiController
RainWorx.FrameWorx.MVC.Areas.API.Controllers.BaseAuctionWorxAPIController
RainWorx.FrameWorx.MVC.Areas.API.ControllersSystemController
Namespace: RainWorx.FrameWorx.MVC.Areas.API.Controllers
Assembly: RainWorx.FrameWorx.MVC (in RainWorx.FrameWorx.MVC.dll) Version: 3.5
Syntax
C#
public class SystemController : AuctionWorxAPIController
The SystemController type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | SystemController | Initializes a new instance of the SystemController class |
Methods
| Name | Description | |
|---|---|---|
| GetBuild |
Retrieves the current Build number. (This value is retrieved from the RainWorx.FrameWorx.BLL dll).
|
| GetVersion |
Retrieves the current version of the API
|
| PostRetrieveAuthToken |
Retrieves an authorization token for additional calls to the Web API
Note, this is a "Post" because using GET for sensitive data is a bad idea for several reasons:
1.) Mostly HTTP referrer leakage (an external image in the target page might leak the password[1])
2.) Password will be stored in server logs (which is obviously bad)
3.) History caches in browsers
[1] Although I need to note that RFC states that browser should not send referrers from HTTPS to HTTP. But that doesn't mean a bad 3rd party browser toolbar or an external image/flash from an HTTPS site won't leak it.
http://stackoverflow.com/questions/323200/is-an-https-query-string-secure
|
Extension Methods
| Name | Description | |
|---|---|---|
 | ToMvcHtmlString |
Returns the HTML version of the ToString() output method of the specified object
(Defined by HtmlHelpers.) |
See Also