Class FacePackController
The Digital Face Pack 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/DigitalFacePackController
Methods
AssociateFaces(Guid, Guid[], Nullable<Boolean>)
Creates multiple facePackZone associations
Declaration
public JsonResult AssociateFaces(Guid facePackID, Guid[] faceIDs, bool? force)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | facePackID | The face pack to which we are adding zones |
| System.Guid[] | faceIDs | An array of face ids |
| System.Nullable<System.Boolean> | force | A boolean indicating whether to force the operation if a confirmation is required or not. Default is not to force the operation, in which case a failure will be returned along with an explanation as to why confirmation is required. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json-encoded array of facePackZoneIds. |
Create(DigitalFacePackModel)
Creates a new digital pack using the specified parameters.
Declaration
public JsonResult Create(DigitalFacePackModel model)Parameters
| Type | Name | Description |
|---|---|---|
| DigitalFacePackModel | model | Model of the digital pack to be created. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | The ID associated with the new digital pack if successfully created. |
Remarks
Faces will NOT be added to the pack even if their ids are specified in the model
Delete(Nullable<Guid>, Nullable<Guid>)
Deletes a digital face pack.
Declaration
public JsonResult Delete(Guid? id, Guid? facePackId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Guid> | id | The Id of the digital face pack to be deleted. |
| System.Nullable<System.Guid> | facePackId | The Id of the digital face pack to be deleted. 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. |
DissassociateFaces(Guid, Guid[])
Deletes FacePackZone associations between the facepack whose id is provided and the zone's whose ids are provided.
Declaration
public JsonResult DissassociateFaces(Guid facePackID, Guid[] faceIDs)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | facePackID | The id of the facepack from which faces are to be removed. |
| System.Guid[] | faceIDs | An array of the ids of the faces to be removed from the facepack |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the delete succeeded, else false. |
Get(Guid)
Return information about the specified digital face pack.
Declaration
public JsonResult Get(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | The ID of the face pack. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded instance of the |
GetByName(String)
Returns the ID of digital face packs with the specified name.
Declaration
public JsonResult GetByName(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name to search for. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array with the IDs of all face packs with the specified name. If no face packs are found, the array will be empty. |
GetFacePackZoneAssociations(Guid)
Return information about all of the facepackZone associations of the the specified digital face pack.
Declaration
public JsonResult GetFacePackZoneAssociations(Guid facePackId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | facePackId | The ID of the face pack. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array of instance of the |
GetMany(Guid[])
Return information about the specified digital face packs.
Declaration
public JsonResult GetMany(Guid[] ids)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | ids | The IDs of the face packs. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array if instances of the |
Search(String, Int32)
Searches all digital face packs.
Declaration
public JsonResult Search(string term, int limit = 25)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | term | Term to search. |
| System.Int32 | limit |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Name and facePackID of all the results that match the search term. |
Update(Nullable<Guid>, Nullable<Guid>, List<Guid>, String, String, Nullable<Guid>, String, Nullable<Guid>, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<DateTime>, String)
Update the specified digital pack.
Only the ID of the digital pack and the fields to be updated need to be specified
Note that if a digital pack has faces associated to it, only the description can be altered
Currently changing the site or digital pack associated to the location is not supported
Declaration
public JsonResult Update(Guid? id, Guid? facePackId, List<Guid> salesMarketIDs, string name, string description, Guid? mediaTypeGroupID, string generalNote, Guid? postingCompanyID, string postingCardNote, string productionNote, int? excpectedFaceCount, int? expectedFaceCount, bool? includeSpares, int? spareQuantity, bool? sparesUsePercentage, bool? isTransparent, bool? isBreakable, DateTime? endDate, string tags)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Guid> | id | The id of the digital pack to be updated. |
| System.Nullable<System.Guid> | facePackId | The Id of the digital pack to be updated. Can be used as an alternate to the |
| System.Collections.Generic.List<System.Guid> | salesMarketIDs | The list of sales markets associated with the digital face pack. Only one item is accepted (salesMarketIds[0]) |
| System.String | name | The Name of the digital face pack. |
| System.String | description | The description of the digital face pack. |
| System.Nullable<System.Guid> | mediaTypeGroupID | The mediaTypeGroup of the digital face pack. Cannot be set to null. |
| System.String | generalNote | The general notes for this digital face pack. |
| System.Nullable<System.Guid> | postingCompanyID | The posting companyId associated with this face pack. |
| System.String | postingCardNote | The posting card note associated with this face pack. |
| System.String | productionNote | The production note associated with this face pack. |
| System.Nullable<System.Int32> | excpectedFaceCount | Obsolete. Included for use with old versions of the |
| System.Nullable<System.Int32> | expectedFaceCount | The expected number of faces for this digital face pack |
| System.Nullable<System.Boolean> | includeSpares | Indicates if spares are included. |
| System.Nullable<System.Int32> | spareQuantity | The quantity of spares. |
| System.Nullable<System.Boolean> | sparesUsePercentage | Indicates if the spare quantity is a percentage rather than a fixed number. |
| System.Nullable<System.Boolean> | isTransparent | Indicates if the face pack is transparent. |
| System.Nullable<System.Boolean> | isBreakable | Indicates if the face is breakable. |
| System.Nullable<System.DateTime> | endDate | The end of the face pack's saleability period. |
| System.String | tags | The tags associated with the digital face pack, separated by commas |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult |
Remarks
Faces will NOT be added to the pack even if their ids are specified in the model