Namespace: Asset

Namespaces

Exception

Manage

Methods

Appearition.Asset.GetAllSites (requestOptions)Array.<Appearition.Asset.SiteViewModel> static

This method will return a lists of sites to use when searching or modifying assets

Name	Type	Description
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.SiteViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartInstance (partId, requestOptions)Array.<Appearition.Asset.PartInstanceViewModel> static

This method will return a list of existing assets (aka part instances) in the database for the given part. Note, this method is very similar to GetPartInstanceDetails where the difference is that this method will not return any sub part assets

Name	Type	Description
partId	number	Unique identifier to a part. Assets of this type of part will be returned
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartInstanceViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartInstanceById (partInstanceId, requestOptions)Array.<Appearition.Asset.PartInstanceViewModel> static

This method will return a specific asset from the database

Name	Type	Description
partInstanceId	number	Uniquely identifies the asset in the database
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartInstanceViewModel>	Note, whilst the return type is a collection, there will only ever by one record returned. This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartInstanceDetails (partId, requestOptions)Appearition.Asset.GetPartInstanceDetailsResponseViewModel static

This method will return a list of existing assets (aka part instances) in the database for the given part. It will also look for assets for the given part which are sub parts of another asset.

Name	Type	Description
partId	number	Unique identifier to the part. Assets of this type of part will be returned
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Appearition.Asset.GetPartInstanceDetailsResponseViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartInstanceHistory (partInstanceId, requestOptions)Array.<Appearition.Asset.PartInstanceHistoryResponseViewModel> static

This method will return a number of fields including a flag indicating if the user is able to modify asset records

Name	Type	Description
partInstanceId	number	Uniquely identifiers the asset in the database which is also referred to as an instance of a part
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartInstanceHistoryResponseViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartInstanceReminderById (partInstanceReminderId, requestOptions)Array.<Appearition.Asset.PartInstanceReminderViewModel> static

This method will return a specific part reminder for a specific asset

Name	Type	Description
partInstanceReminderId	number	Uniquely identifies the part reminder record for an asset in the database
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartInstanceReminderViewModel>	Note, whilst the return type is a collection, only one record would ever be in the collection. This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartInstanceReminders (partInstanceId, requestOptions)Array.<Appearition.Asset.PartInstanceReminderViewModel> static

This method will return all part reminders that have been configured for the specific asset

Name	Type	Description
partInstanceId	number	Uniquely identifies the asset in the database
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartInstanceReminderViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetPartners (requestOptions)Appearition.Asset.GetPartResponseViewModel static

This method will return various list of information used for adding or modifying assets

Name	Type	Description
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Appearition.Asset.GetPartResponseViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetParts (partId, requestOptions)Array.<Appearition.Asset.PartViewModel> static

This method will return a collection of parts that can be used to search or create new instances

Name	Type	Description
partId	number	If specified, will return that one part, otherwise all parts will be returned. Set to NULL if you want to return all part records
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetSiteParts (request, requestOptions)Array.<Appearition.Asset.SitePartViewModel> static

This method will return all assets for a given combination of Site and Part. There are other parameters that can be used to filter results

Name	Type	Description
request	Appearition.Asset.GetSitePartsRequestViewModel	Parameters to configure search filter
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.SitePartViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetStaticOptions (requestOptions)Appearition.Asset.GetStaticOptionsResponseViewModel static

This method will return various lists of data that need to be used when searching or maintaining assets

Name	Type	Description
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Appearition.Asset.GetStaticOptionsResponseViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.GetSubpartInstance (partId, requestOptions)Array.<Appearition.Asset.PartInstanceViewModel> static

This method will return a list of existing sub part assets (aka sub part instances) in the database for the given part. Note, this method is very similar to GetPartInstanceDetails where the difference is that this method will not return any parent assets

Name	Type	Description
partId	number	Unique identifier to a part. Assets of this type of part will be returned
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Array.<Appearition.Asset.PartInstanceViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Asset.Index (requestOptions)Appearition.Asset.AssetMaintenanceViewModel static

This method will return a number of fields including a flag indicating if the user is able to modify asset records

Name	Type	Description
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Appearition.Asset.AssetMaintenanceViewModel	This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.Asset.AssetMaintenanceViewModel

This data structure holds details retrieved as part of the index request

Properties:

Name	Type	Description
IsReadOnly	boolean	Indicates if the logged in user can only read asset information
UserEmailAddress	string	Deprecated. The email address of the logged in user

Appearition.Asset.GetPartInstanceDetailsResponseViewModel

This data structure holds information about assets

Properties:

Name	Type	Description
PartInstances	Array.<Appearition.Asset.PartInstanceViewModel>	A collection of assets which have no parent assets (i.e. they are NOT sub parts)
SubPartInstances	Array.<Appearition.Asset.PartInstanceViewModel>	A collection of assets which are configured as sub parts to another asset

Appearition.Asset.GetPartResponseViewModel

This data structure holds various lists used to modify asset records

Properties:

Name	Type	Description
Manufacturers	Array.<Appearition.ListItemViewModel>	A collection of part manufacturers
ManufacturerModels	Array.<Appearition.ListItemViewModel>	A collection of models that part manufacturers make
Suppliers	Array.<Appearition.ListItemViewModel>	A collection of suppliers of parts
Repairers	Array.<Appearition.ListItemViewModel>	A collection of repairers for faulty parts
Categories	Array.<Appearition.ListItemViewModel>	A collection of categories that parts can be grouped under

Appearition.Asset.GetSitePartsRequestViewModel

This data structure configures parameters when requesting a search query for assets

Properties:

Name	Type	Description
PartStatus	Appearition.Asset.PartStatusEnum	Numeric value of PartStatusEnum
SiteId	number	Unique identifier to a site
PartId	number	Unique identifier to a part
PartCategoryId	number	Unique identifier to a category of parts
BarcodeOrSerialNumberSearchString	string	Text to use for searching for assets by barcode OR serial number
SiteStatus	Appearition.Site.SiteStatusEnum	Numeric value of SiteStatusEnum

Appearition.Asset.GetStaticOptionsResponseViewModel

This data structure holds various lists of data used when viewing or modifying assets

Properties:

Name	Type	Description
ShelterTypeOptions	Array.<Appearition.ListItemViewModel>	List of Appearition.Site.ShelterTypeEnum
PartStatusOptions	Array.<Appearition.Asset.PartStatusViewModel>	List of Appearition.Asset.PartStatusEnum
SiteStatusOptions	Array.<Appearition.ListItemViewModel>	List of Appearition.Site.SiteStatusEnum
RecurranceTypeList	Array.<Appearition.SelectListItem>	List of Appearition.Part.Manage.RecurranceEnum
ReminderDateTypeList	Array.<Appearition.SelectListItem>	List of Appearition.Part.Manage.ReminderDateTypeEnum
FirstReminderDateIntervalTypeList	Array.<Appearition.SelectListItem>	List of Appearition.Part.Manage.FirstReminderDateIntervalTypeEnum

Appearition.Asset.PartInstanceHistoryResponseViewModel

This data structure holds a snapshot of an asset at a point in time

Properties:

Name	Type	Description
IsLinkedToSubmittedFormData	boolean	Indicates if the change to this asset was a result of an action on a submitted form
JobAssignmentFormFieldId	number	If the change to this asset was a result of an action on a submitted form, this property identifies the exact field in the exact submitted form where the action was recorded
Barcode	string	Is an identifier of this asset
SerialNo	string	Is an identifier of this asset
DateOfPurchase	string	The date when this asset was purchased
WarrantyExpiryDate	string	The date when the warranty on this asset will expire
Comment	string	Arbitrary text about this asset
ManufacturerName	string	The name of the manufacturer of this asset
ModelNo	string	The model of this asset
RepairerName	string	The name of the repairer for this asset
SupplierName	string	The name of the supplier for this asset
PartStatus	string	The text description of the status of this asset. Refer to Appearition.Asset.PartStatusEnum
ModifiedByUsername	string	The user who made this change. If the change was a result of an action on a submitted form, then this field will contain the username on that form.
ModifiedByFirstName	string	The first name of the user who made the change
ModifiedByLastName	string	The last name of the user who made the change
ModifiedUtcDate	string	The date and time in UTC format of when the change was made
ModifiedLocalDate	string	The date and time in a format local to the logged in user of when the change was made. Note, if the timezone of the logged in user is not known, then the UTC date will be returned instead.
Event	string	As summary description of what change was made to the asset
PartName	string	The name of the part that this asset is
SiteName	string	The name of the site that this asset was located at the time of the change
SiteNo	string	An identifier the site that this asset was located at the time of the change
FormName	string	If the change to this asset was a result of an action on a submitted form, this property holds the name of that form
RelatedPartInstanceId	number	If the change relates to another asset in the database, this property would hold a reference to that other asset. For example, moving a sub part from one parent to another
RelatedPartName	string	If the change relates to another asset in the database, this property holds the name of the part of the other asset
RelatedPartBarcode	string	If the change relates to another asset in the database, this property holds the barcode of other asset
RelatedPartSerialNo	string	If the change relates to another asset in the database, this property holds the serial number of other asset

Appearition.Asset.PartInstanceReminderViewModel

This data structure holds configuration for a reminder for a specific asset

Properties:

Name	Type	Description
Id	number	Uniquely identifies the reminder record
PartId	number	Uniquely identifies the type of part the asset it
PartInstanceId	number	Uniquely identifies the asset which this reminder is linked to
FirstReminderDate	string	The date when the first reminder is due
StopDate	string	The date when the all reminders must stop
Comments	string	The text that is included as part of the reminder notification message
IsEmailReminder	boolean	Indicates if the reminder notification should be sent via email
IsExceptionItemRaised	boolean	Indicates if the reminder notification should be raised as an asset exception message
ReminderEmails	string	If IsEmailReminder is true, this will hold a comma separated list of email addresses who will receive the reminder notification massage
RecurranceType	Appearition.Part.Manage.RecurranceEnum	e.g. days, weeks, etc. Refer to Appearition.Part.Manage.RecurranceEnum
RecurranceName	string	The name of the RecurranceType
IsOnce	boolean	Indicates if only one reminder should be sent
RecurranceValue	number	If the reminders will be repeated, this represents the numeric frequency. e.g. Every 3 days or Every 1 week
PartName	string	The name of the part that the asset is

Appearition.Asset.PartInstanceViewModel

This data structure holds the current details of an asset in the database

Properties:

Name	Type	Description
Id	number	Unique identifier to the asset. System allocated
SiteId	number	Unique identifier to the site that this asset is currently located at
SiteNo	string	An identifier the site that this asset was located at the time of the change
SiteName	string	The name of the site that this asset was located at the time of the change
PartId	number	Unique identifier of the part that this asset is
PartName	string	The name of the part that this asset is
PartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum.
PartStatusName	string	The name of the PartStatus
Barcode	string	Is an identifier of this asset
SerialNo	string	Is an identifier of this asset
DateOfPurchase	string	The date when this asset was purchased
WarrantyExpiryDate	string	The date when the warranty on this asset will expire
Comment	string	Arbitrary text about this asset
ManufacturerModelId	string	Unique identifier of the model record listed against this asset
ManufacturerId	string	Unique identifier of the manufacturer listed against this asset
ManufacturerName	string	The name of the manufacturer of this asset
ModelNo	string	The model of this asset
RepairerId	number	Unique identifier of the repairer for this asset
RepairerName	string	The name of the repairer for this asset
SupplierId	number	Unique identifier of the supplier for this asset
SupplierName	string	The name of the supplier for this asset
PartInstanceId	string	Same as Id
SubPartInstanceId	string	If this asset is a sub part, this property holds the unique identifier to the record that links this instance to the parent instance
IsActive	string	always set to true
CreatedUtcDate	string	The date and time in UTC format of when the asset record was first created in the database
ModifiedUtcDate	string	The date and time in UTC format of when the most recent change was made to the asset record in the database
ParentBarcode	string	If this asset is sub part, this property holds the barcode of the parent asset
ParentSerialNo	string	If this asset is sub part, this property holds the serial number of the parent asset
ParentPartName	string	If this asset is sub part, this property holds the name of the part that the parent asset is
ParentSiteId	string	If this asset is sub part, this property holds the unique identifier to the site that the parent asset is currently at
ParentSiteNo	string	If this asset is sub part, this property holds an identifier to the site that the parent asset is currently at
ParentSiteName	string	If this asset is sub part, this property holds that name of the site that the parent asset is currently at
ParentPartStatus	Appearition.Asset.PartStatusEnum	If this asset is sub part, this property holds that status of the parent asset
ParentPartStatusName	string	If this asset is sub part, this property holds that name of the ParentPartStatus
ParentManufacturerId	number	If this asset is sub part, this property holds that unique identifier of the manufacturer of the parent asset
ParentManufacturer	string	If this asset is sub part, this property holds the name of the manufacturer of the parent asset
ParentManufacturerModelId	string	If this asset is sub part, this property holds the unique identifier to the manufacturer model of the parent asset
ParentModelNo	string	If this asset is sub part, this property holds the model details of the parent asset

Appearition.Asset.PartStatusEnum

The various status values for an asset (aka part instance)

Properties:

Name	Type	Description
InStorage:	number	1201
InService:	number	1202
Faulty:	number	1203
AtRepairer:	number	1204
Retired:	number	1205
InServiceNotCommissioned:	number	1206

Appearition.Asset.PartStatusViewModel

This data structure holds information about the state of asset

Properties:

Name	Type	Description
IsInService	boolean	Indicates if the asset is operational
IsFaulty	boolean	Indicates if the asset is faulty

Appearition.Asset.PartViewModel

This data structure holds information about a part used in assets

Properties:

Name	Type	Description
Id	number	Unique identifier to the part
Name	string	The name of the part
EquipmentIdentifier	string	A property of part
Description	string	A property of part

Appearition.Asset.SitePartInstanceViewModel

This model holds the details of all assets of a particular type (i.e. part) at a given location (i.e. site)

Properties:

Name	Type	Description
PartInstanceId	number	Uniquely identifies the asset in the database
SiteId	number	Unique identifier to a site
PartId	number	Unique identifier to a part
PartStatus	Appearition.Asset.PartStatusEnum	The numerical value of the PartStatusEnum.
PartStatusName	string	The name of the PartStatus
Barcode	string	Is an identifier of this asset
SerialNo	string	Is an identifier of this asset
DateOfPurchase	string	The date when this asset was purchased
WarrantyExpiryDate	string	The date when the warranty on this asset will expire
Comment	string	Arbitrary text about this asset
ManufacturerModelId	string	Unique identifier of the model record listed against this asset
ManufacturerId	string	Unique identifier of the manufacturer listed against this asset
ManufacturerName	string	The name of the manufacturer of this asset
ModelNo	string	The model of this asset
RepairerId	number	Unique identifier of the repairer for this asset
RepairerName	string	The name of the repairer for this asset
SupplierId	number	Unique identifier of the supplier for this asset
SupplierName	string	The name of the supplier for this asset
SubParts	Array.<Appearition.Asset.PartInstanceViewModel>	The collection of assets which are children (i.e. my sub parts)
SubPartsOf	Array.<Appearition.Asset.PartInstanceViewModel>	The collection of parents that this asset is a child of. Note in most cases there will only be 1 in this collection, however an array exist for possible future requirements

Appearition.Asset.SitePartViewModel

This model holds all the assets of a particular type (i.e. part) at a given location (i.e. site)

Properties:

Name	Type	Description
SiteId	number	Unique identifier to a site
PartId	number	Unique identifier to a part
StockCount	number	The total number of assets (specific to the part id) at the site. This is the current value in the database.
MinCount	number	The minimum amount of assets that should exist at the site of the particular part
MaxCount	number	The maximum amount of assets that can exist at the site of the particular part
Barcodes	Array.<Appearition.Asset.SitePartInstanceViewModel>	The collection of all assets for this combination of site and part

Appearition.Asset.SiteViewModel

This data structure holds information about a site used in assets

Properties:

Name	Type	Description
Id	number	Unique identifier to the site
Name	string	The name of the site
SiteNo	string	An identifier to the site
IsSite	boolean	Indicates if this site record represents a location where assets exist and are in service and operational
IsDepot	boolean	Indicates if this site record represents a location where assets are stored and ready to be taken and installed at a site
IsRepairer	boolean	Indicates if this site record represents a repairer location where faulty assets are taken to for fixing.