Appearition Platform JS

Namespace: Site

Appearition.Site

Use the functions under this module to access Site records on the Appearition platform

Namespaces

Document
Manage

Methods

Appearition.Site.GetSiteDocument (siteDocumentId, requestOptions)object static

Retrieves the contents of a specific submitted file

Name Type Description
siteDocumentId number

The unique identifier of the document
requestOptions Appearition.RequestOptions

Contains the various callback methods for this request
Returns:
Type Description
object File stream

Appearition.Site.GetSiteSyncManifest (request, requestOptions)Appearition.Site.SiteSyncManifestViewModel static

Retrieves a delta of modified site on the server. The delta is determined from the view model sent in the request body Will return the Appearition.Site.SiteSyncManifestViewModel model

Name Type Description
request Appearition.Site.SiteSyncManifestViewModel

Contains the identifiers for retrieving the required records
requestOptions Appearition.RequestOptions

Contains the various callback methods for this request
Returns:
Type Description
Appearition.Site.SiteSyncManifestViewModel This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.Site.MainsHybridGensetEnum

The various values for a the Mains Hybrid Genset property of a site

Properties:
Name Type Description
NotApplicable number

900
Unknown number

901

Appearition.Site.ShelterTypeEnum

The various types of shelters which is a property of a site. Please note, these values are subject to change. They are dependent on the customer requirements and change from instance to instance. The consistency is the numbers, but the labels do change. More numbers can also be added. It is often used to describe the type of site record.

Properties:
Name Type Description
Solar number

101
Standard number

102
Depot number

104
Repairer number

105

Appearition.Site.SiteDocSyncManifestViewModel

This data structure holds the details of a document specific to a site

Properties:
Name Type Description
DocumentId number

The unique identifier of the document
FormKey string

Identifies the specific form that this document relates to. If set, this document will only be presented when the user is working with the specified form. If left empty, then all forms will present this document
VersionNo number

Identifies the specific version of this document
DocumentName string

The title given to the document. Note this will differ to the File Name
DateModified string

The date/time as UTC, that this document was last changed.
FileName string

The name of the file
IsActive boolean

During the site sync process, if the client posted a document which is not longer available on the server, then this field will be set to false and the client should immediately remove the document from any local cache

Appearition.Site.SiteStatusEnum

The various status values for a site. Please note, these values are subject to change. They are dependent on the customer requirements and change from instance to instance. The consistency is the numbers, but the labels do change. More numbers can also be added.

Properties:
Name Type Description
NotApplicable number

700
PreCAPEXOperational number

701
UnderCAPEXUpgrade number

702
OperationalNotCommissioned number

703
OperationalInService number

704
Cancelled number

705

Appearition.Site.SiteSyncManifestViewModel

This data structure holds the details of all sites synchronised from server to client

Properties:
Name Type Description
Sites Array.<Appearition.Site.SiteSyncViewModel>

A collection of site records

Appearition.Site.SiteSyncViewModel

Represents a Site and all of the details

Properties:
Name Type Description
SiteId number

The unique identifier for the site
SiteName string

The name of the Site
MainsHybridGenset Appearition.Site.MainsHybridGensetEnum

The numerical value of the MainsHybridGensetEnum.
ShelterType Appearition.Site.ShelterTypeEnum

The numerical value of the ShelterTypeEnum.
AtlType string

A text property of site
EquipmentDisposition string

A text property of site
UpgradeSpecialRequirements string

A text property of site
Region string

A text property of site
SiteType string

A text property of site
Housing string

A text property of site
AccessDetails string

A text property of site
Map string

A text property of site
MapRef string

A text property of site
Address string

A text property of site
AmgGrid string

A text property of site
Easting string

A text property of site
Northing string

A text property of site
MobileCover string

A text property of site
KeyAccess string

A text property of site
Owner string

A text property of site
IsKeySafeInstalled boolean

A boolean property of site
CompoundKey string

A text property of site
ShelterKey string

A text property of site
CabinetKey string

A text property of site
Latitude number

A coordinate used for the GPS location
Longitude number

A coordinate used for the GPS location
Docs Array.<Appearition.Site.SiteDocSyncManifestViewModel>

A collection of documents related to this specific site