Class FaceController
The Face 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/Face
Methods
AddChildFaces(Guid, Guid[])
Adds child faces to a virtual face.
Declaration
public JsonResult AddChildFaces(Guid parentFaceID, Guid[] childFaceIDs)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | parentFaceID | The ID of the parent face. This must be static virtual face or a digital face with multiple zones. |
| System.Guid[] | childFaceIDs | The IDs of the child faces. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
Create(PI.SDK.Models.FaceModel)
Creates a new face using the specified parameters.
Declaration
public JsonResult Create(PI.SDK.Models.FaceModel model)Parameters
| Type | Name | Description |
|---|---|---|
| PI.SDK.Models.FaceModel | model | Model of the face to be created. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | The ID associated with the new face if successfully created. |
Delete(Guid)
Declaration
public JsonResult Delete(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
GetAllFaceIds()
Declaration
public JsonResult GetAllFaceIds()Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
GetByNumber(String)
Gets the Face by Number.
Declaration
public JsonResult GetByNumber(string number)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | number | Number of the Face |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | The Face if found. |
GetChildFaceIDs(Guid)
Retrieves the IDs of the children of a virtual face.
Declaration
public JsonResult GetChildFaceIDs(Guid parentFaceID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | parentFaceID | The ID of the parent face. This must be static virtual face or a digital face with multiple zones. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | An array containing the IDs of the child faces. If the specified face does not have any children, an empty array is returned. |
GetDetailedInformation(Guid[])
Declaration
public JsonResult GetDetailedInformation(Guid[] faceId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | faceId |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
GetFace(Guid)
Gets all properties of a given face.
Declaration
public JsonResult GetFace(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the face. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Model of the face corresponding to the Face ID. |
GetFaceAttributes(Guid)
Gets all attributes associated with a given face.
Declaration
public JsonResult GetFaceAttributes(Guid faceID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | faceID | ID of the face. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Attributes associated with the face. |
GetFaceAttributesByNumber(String)
Gets all attributes associated with a given face.
Declaration
public JsonResult GetFaceAttributesByNumber(string number)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | number | number of the face. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Attributes associated with the face. |
GetFaceByNumber(String)
Gets all properties of a given face.
Declaration
public JsonResult GetFaceByNumber(string number)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | number | Number of the face. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Model of the face corresponding to the Face Number. |
GetFaceInventoryAttributes(Guid[])
Returns a partially filled DetailedFace object, containing the face, it's description, and inventory attributes. Other fields are not guaranteed to be filled
Declaration
public JsonResult GetFaceInventoryAttributes(Guid[] faceIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | faceIds | A list of faceIds. If null, returns the information for all faces |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
GetFacePostings(String, DateTime, DateTime, String, String, String)
Declaration
public JsonResult GetFacePostings(string CompanyCode, DateTime FromDate, DateTime ToDate, string SalesMarketCode, string FaceNumber, string SiteNumber)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | CompanyCode | |
| System.DateTime | FromDate | |
| System.DateTime | ToDate | |
| System.String | SalesMarketCode | |
| System.String | FaceNumber | |
| System.String | SiteNumber |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
RemoveChildFaces(Guid, Guid[])
Removes child faces from a virtual face.
Declaration
public JsonResult RemoveChildFaces(Guid parentFaceID, Guid[] childFaceIDs)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | parentFaceID | The ID of the parent face. This must be static virtual face or a digital face with multiple zones. |
| System.Guid[] | childFaceIDs | The IDs of the child faces. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
RetireFace(Guid, DateTime, Guid)
Retire the face as specified by the id.
Declaration
public JsonResult RetireFace(Guid id, DateTime retiredDate, Guid retiredReason)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the face to be retired. |
| System.DateTime | retiredDate | Date on which the face is to be retired. |
| System.Guid | retiredReason | Reason for which the face is retired. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
|
Search(String, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Boolean>, Nullable<Boolean>, Int32)
Searches all faces.
Declaration
public JsonResult Search(string term = null, Guid? areaID = default(Guid? ), Guid? companyID = default(Guid? ), Guid? mediaTypeID = default(Guid? ), Guid? mediaTypeGroupID = default(Guid? ), Guid? faceSizeID = default(Guid? ), bool? isDigital = default(bool? ), bool? isSaleable = default(bool? ), int limit = 25)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | term | Optional. Type: String. A term to search in the face number. |
| System.Nullable<System.Guid> | areaID | Optional. Type: Guid. If specified, the faces are filtered to include only those in the specified area. |
| System.Nullable<System.Guid> | companyID | Optional. Type: Guid. If specified, the faces are filtered to include only those belonging to the specified company. |
| System.Nullable<System.Guid> | mediaTypeID | Optional. Type: Guid. If specified, the faces are filtered to include only those with the specified media type. |
| System.Nullable<System.Guid> | mediaTypeGroupID | Optional. Type: Guid. If specified, the faces are filtered to include only those with the specified media type group. |
| System.Nullable<System.Guid> | faceSizeID | Optional. Type: Guid. If specified, the faces are filtered to include only those with the specified face size. |
| System.Nullable<System.Boolean> | isDigital | Optional. Type: Guid. If specified, the faces are filtered to include only those that are or are not digital. |
| System.Nullable<System.Boolean> | isSaleable | Optional. Type: Guid. If specified, the faces are filtered to include only those that are or are not saleable. |
| System.Int32 | limit |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Number and Face ID of all the results that match the search term. |
Update(Guid, String, String, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Guid>, Nullable<Boolean>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Guid>, String, String, String, Nullable<Double>, Nullable<Double>, Nullable<Guid>, Nullable<Boolean>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, String, Nullable<Guid>, Nullable<Boolean>, Nullable<Int32>)
Updates the face with the specified parameters.
Declaration
public JsonResult Update(Guid id, string number, string description, Guid? mediaTypeID, Guid? networkID, Guid? faceLocationTypeID, Guid? structureTypeID, Guid? faceSizeID, Guid? materialID, Guid? illuminationTypeID, Guid? directionFacingID, bool? isSaleable, DateTime? saleableAsOfDate, DateTime? retiredAsOfDate, Guid? retiredReasonID, string tabPanelID, string generaleNote, string faceAt, double? latitude, double? longitude, Guid? faceGroupID, bool? isCopyApprovalRequired, string reportTag, int? screenMultiplier, int? canvasLayoutX, int? canvasLayoutY, int? canvasLayoutWidth, int? canvasLayoutHeight, string SynchronizationGroupName, Guid? masterZoneID, bool? enableSynchronization, int? frameSynchPortRangeStart)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the face to be updated. |
| System.String | number | Number of the face to be updated. |
| System.String | description | Description of the face to be updated. |
| System.Nullable<System.Guid> | mediaTypeID | Media Type ID associated with the face to be updated. |
| System.Nullable<System.Guid> | networkID | |
| System.Nullable<System.Guid> | faceLocationTypeID | |
| System.Nullable<System.Guid> | structureTypeID | |
| System.Nullable<System.Guid> | faceSizeID | |
| System.Nullable<System.Guid> | materialID | |
| System.Nullable<System.Guid> | illuminationTypeID | |
| System.Nullable<System.Guid> | directionFacingID | |
| System.Nullable<System.Boolean> | isSaleable | |
| System.Nullable<System.DateTime> | saleableAsOfDate | |
| System.Nullable<System.DateTime> | retiredAsOfDate | |
| System.Nullable<System.Guid> | retiredReasonID | |
| System.String | tabPanelID | |
| System.String | generaleNote | |
| System.String | faceAt | |
| System.Nullable<System.Double> | latitude | |
| System.Nullable<System.Double> | longitude | |
| System.Nullable<System.Guid> | faceGroupID | |
| System.Nullable<System.Boolean> | isCopyApprovalRequired | |
| System.String | reportTag | |
| System.Nullable<System.Int32> | screenMultiplier | |
| System.Nullable<System.Int32> | canvasLayoutX | |
| System.Nullable<System.Int32> | canvasLayoutY | |
| System.Nullable<System.Int32> | canvasLayoutWidth | |
| System.Nullable<System.Int32> | canvasLayoutHeight | |
| System.String | SynchronizationGroupName | |
| System.Nullable<System.Guid> | masterZoneID | |
| System.Nullable<System.Boolean> | enableSynchronization | |
| System.Nullable<System.Int32> | frameSynchPortRangeStart |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
|