Class DirectionFacingController
The DirectionFacing Controller is a controller that allows data to be retrieved and updated within the Ayuda Platform.
Namespace: Ayuda.BMS.Splash.Areas.Pi.Controllers
Remarks
This web service can be accessed using an address similar to the following: https://[AYUDA DEPLOYMENT URL]/Juice/Pi/DirectionFacing
Methods
Create(DirectionFacingModel)
Creates a new Direction Facing using the specified parameters.
Declaration
public JsonResult Create(DirectionFacingModel model)Parameters
| Type | Name | Description |
|---|---|---|
| DirectionFacingModel | model | Model of the Direction Facing to be created. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | The ID associated with the new Direction Facing if successfully created. |
Delete(Guid)
Deletes the Direction Facing as specified by the id.
Declaration
public JsonResult Delete(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the Direction Facing to be deleted. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
|
GetAll()
Gets all the directions.
Declaration
public JsonResult GetAll()Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array with the information about all the face directions. |
GetByAbbreviation(String)
Gets the DirectionFacing by Code.
Declaration
public JsonResult GetByAbbreviation(string abbr)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | abbr | Abbreviation of the DirectionFacing |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | The DirectionFacing if found. |
Update(Guid, String, String, String, Nullable<Boolean>)
Updates the Direction Facing with the specified parameters.
Declaration
public JsonResult Update(Guid id, string culture, string name, string abbreviation, bool? isLive)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the Direction Facing to be updated. |
| System.String | culture | Language to update (if updating localizable fields). |
| System.String | name | Name of the Direction Facing. Localizable. |
| System.String | abbreviation | Name of the Direction Facing. Localizable. |
| System.Nullable<System.Boolean> | isLive | True if the Direction Facing is available and usable. False if it is archived. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
|