Class FrameController
The Frame 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/Frame
Methods
Create(PI.SDK.Models.FrameModel)
Creates a new frame using the specified parameters.
Declaration
public JsonResult Create(PI.SDK.Models.FrameModel model)Parameters
| Type | Name | Description |
|---|---|---|
| PI.SDK.Models.FrameModel | model | Model of the frame to be created. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | The ID associated with the new frame if successfully created. |
Delete(Nullable<Guid>, Nullable<Guid>)
Delete a frame.
Declaration
public JsonResult Delete(Guid? id, Guid? frameID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Guid> | id | The Id of the location to be updated. |
| System.Nullable<System.Guid> | frameID | The Id of the frame to be updated. Can be used as an alternate to the |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the delete succeeded, else false. |
GetFrameByID(Guid)
Gets all properties of a given frame.
Declaration
public JsonResult GetFrameByID(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | FrameID of the frame. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Model of the frame corresponding to the FrameID. |
GetFrameByNumber(String)
Gets all properties of a given frame.
Declaration
public JsonResult GetFrameByNumber(string number)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | number | Number of the frame. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Model of the frame corresponding to the Frame Number. |
Update(Nullable<Guid>, Nullable<Guid>, String, String, Nullable<Guid>, Nullable<Boolean>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>)
Update the specified Frame.
Only the ID of the Frame and the fields to be updated need to be specified
Note that if a frame has faces associated to it, only the description can be altered
Currently changing the site or location associated to the frame is not supported
Declaration
public JsonResult Update(Guid? id, Guid? frameID, string number, string description, Guid? frameTypeID, bool? isSaleable, DateTime? saleableAsOfDate, DateTime? retiredAsOfDate, Guid? siteID, Guid? vehicleID, Guid? locationID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Guid> | id | The Id of the location to be updated. |
| System.Nullable<System.Guid> | frameID | The Id of the frame to be updated. Can be used as an alternate to the |
| System.String | number | The number of the frame to be updated |
| System.String | description | The description of the frame to be updated |
| System.Nullable<System.Guid> | frameTypeID | The frameTypeID of the frame to be updated |
| System.Nullable<System.Boolean> | isSaleable | Wether faces on the frame is saleable or not. Only editable if the frame has no faces |
| System.Nullable<System.DateTime> | saleableAsOfDate | Date from which the faces on the frame are saleable. Only editable if the frame has no faces |
| System.Nullable<System.DateTime> | retiredAsOfDate | Date beyond which the faces on the frame are no longer saleable. Only editable if the frame has no faces |
| System.Nullable<System.Guid> | siteID | The ID of the site associated to the frame be updated, if there are no location or vehicle to be associated with the frame. |
| System.Nullable<System.Guid> | vehicleID | The Id of the vehicle associated to the frame to be updated, if there are no location to be associated with the frame. |
| System.Nullable<System.Guid> | locationID | The Id of the location associated to the frame to be updated, if any. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the update succeeded, else false. |