Namespace: Manage

Methods

Appearition.Site.Manage.CreateSite (request, requestOptions)number static

Will create a new site record and return the system allocated unique identifier (SiteId).

Name	Type	Description
request	Appearition.Site.Manage.SiteViewModel	Contains the details of the site
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
number	The system allocated SiteId will be returned for the newly created site. This is returned as part of the success callback function in the requestOptions param

Appearition.Site.Manage.DeleteSite (request, requestOptions) static

Will delete an existing site record. Note, in the request you MUST provide comments as to why the site is being deleted (used for audit purposes). Nothing will be returned unless an error occurs.

Name	Type	Description
request	Appearition.Site.Manage.SiteViewModel	Contains the details of the site
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.Site.Manage.GetSite (request, requestOptions)Appearition.Site.Manage.SiteViewModel static

Retrieves a site as specified by the Id property of the request Will return the Appearition.Site.Manage.SiteViewModel model

Name	Type	Description
request	Appearition.Site.Manage.SiteListItemViewModel	Contains the identifiers for retrieving the required records
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
Appearition.Site.Manage.SiteViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Site.Manage.Index (requestOptions)Appearition.Site.Manage.SiteIndexViewModel static

This method will return various data for setting up the index page of a site management UI. It will also fetch and return a paged set of site records It will return a Appearition.Site.Manage.SiteIndexViewModel object

Name	Type	Description
requestOptions	Appearition.RequestOptions	configure callbacks

Returns:

Type	Description
Appearition.Site.Manage.SiteIndexViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Site.Manage.ListSites (request, requestOptions)Array.<Appearition.Site.Manage.SiteListItemViewModel> static

Retrieves a list of sites filtered by the criteria specified in the request Will return a collection of Appearition.Site.Manage.SiteListItemViewModel model

Name	Type	Description
request	Appearition.Site.Manage.SiteListItemViewModel	Contains the identifiers for retrieving the required records
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

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

Appearition.Site.Manage.UpdateSite (request, requestOptions) static

Will update the details of an existing site record. Nothing will be returned unless an error occurs.

Name	Type	Description
request	Appearition.Site.Manage.SiteViewModel	Contains the details of the site
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Type Definitions

Appearition.Site.Manage.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.Manage.SiteIndexViewModel

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

Properties:

Name	Type	Description
Sites	Array.<Appearition.Site.Manage.SiteListItemViewModel>	A collection of site records
Site	Appearition.Site.Manage.SiteViewModel	Can be used with a UI when creating a new site record.
Paging	Appearition.Site.Manage.SitePagingViewModel	Used to configure criteria when searching for sites server side
ShelterTypeList	Array.<Appearition.SelectListItem>	A list of ShelterTypeEnums that can be used when creating or editing a site
MainsHybridGensetList	Array.<Appearition.SelectListItem>	A list of MainsHybridGensetEnums that can be used when creating or editing a site
SiteStatusList	Array.<Appearition.SelectListItem>	A list of SiteStatusEnums that can be used when creating or editing a site

Appearition.Site.Manage.SiteListItemViewModel

This data model holds summary details of a site record. Mainly used as part of a search

Properties:

Name	Type	Description
Id	number	The unique identifier for the site. This is system generated
SiteNo	string	An identifier for the site. This is a mandatory property
SiteName	string	The name of the Site
ShelterTypeName	string	The name of the ShelterTypeEnum selected on the site record
MainsHybridGensetName	string	The name of the MainsHybridGensetEnum selected on the site record
SiteStatus	Appearition.Site.SiteStatusEnum	The numerical value of the SiteStatusEnum. This is a mandatory property
SiteStatusName	string	The name of the SiteStatus
SiteType	string	A text property of site
Housing	string	A text property of site
TotalRecords	number	The total number of sites found as part of a search which returned this site record

Appearition.Site.Manage.SitePagingViewModel

This data structure holds the search criteria posted to the server when searching for sites

Properties:

Name	Type	Description
SiteNo	string	An identifier for the site. This is a mandatory property
SiteName	string	The name of the Site
ShelterType	Appearition.Site.ShelterTypeEnum	The numerical value of the ShelterTypeEnum. This is a mandatory property
ShelterTypeText	string	The name of the ShelterType
Page	number	The page number of result set (zero based index)
RecordsPerPage	number	The total number of results per page that the server will retrieve

Appearition.Site.Manage.SiteSyncManifestViewModel

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

Properties:

Name	Type	Description
ProjectId	number	The unique identifier of the project (aka channel)
UserProfileUsername	string	The unique username for the logged in user
Sites	Array.<Appearition.Site.Manage.SiteSyncViewModel>	A collection of site records

Appearition.Site.Manage.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.Manage.SiteDocSyncManifestViewModel>	A collection of documents related to this specific site

Appearition.Site.Manage.SiteViewModel

Represents a Site and all of the details

Properties:

Name	Type	Description
Id	number	The unique identifier for the site. This is system generated
SiteNo	string	An identifier for the site. This is a mandatory property
SiteNoOriginal	string	The original value as entered by the user. Used to handle rollback actions when editing
SiteName	string	The name of the Site
ShelterType	Appearition.Site.ShelterTypeEnum	The numerical value of the ShelterTypeEnum. This is a mandatory property
ShelterTypeName	string	The name of the ShelterType
SiteStatus	Appearition.Site.SiteStatusEnum	The numerical value of the SiteStatusEnum. This is a mandatory property
SiteStatusName	string	The name of the SiteStatus
MainsHybridGenset	Appearition.Site.MainsHybridGensetEnum	The numerical value of the MainsHybridGensetEnum.
MainsHybridGensetName	string	The name of the MainsHybridGenset
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
Comments	string	A field to entering comments.