Ngage Web Service API

All the API methods below can be used synchronously or asynchronously and are cached with three different options:

  • Fixed Cache: Data is cached for a fixed length of time.
  • Temp Cache: Data is cached for the duration of the same request.
  • Tree Cache: Data is cached until data is changed with the Tree table.

We advise using these web methods rather than a direct database connection, you will achieve a massive performance increase for your front end websites.

 

GetCustomData

Returns a datatable of data for the passed in stored procedure name, used for custom data calls.

Properties

  • StoredProcedureName

Object Returned

DataTable

Code Example

DataTable item = Helper.Data.GetCustomData('storedProcedureName');
 

AddressCountryCodes_SelectAll

Returns a list of address countries and any associated information.

Object Returned

List<ngage_AddressCountryCodes_SelectAllResult>
  • CountryCode (string)
  • CountryName (string)
  • Id (int)
  • NgageListValue (string)
  • Ordinal (int)
  • PostcodeRegex (string)
  • PostcodeSpace (int)
  • StateType (string)

Code Example

List<ngage_AddressCountryCodes_SelectAllResult> item = Helper.Data.ngage_AddressCountryCodes_SelectAll();
 

AddressCountryCodes_SelectByCountryCode

Returns a address country and any associated information for the passed in country code.

Properties

  • CountryCode

Object Returned

ngage_AddressCountryCodes_SelectByCountryCodeResult
  • CountryCode (string)
  • CountryName (string)
  • Id (int)
  • MobileRegex (string)
  • NgageListValue (string)
  • Ordinal (int)
  • PhoneRegex (string)
  • PostcodeRegex (string)
  • PostcodeSpace (int)
  • StateType (string)
  • TaxAllowed (bool)

Code Example

ngage_AddressCountryCodes_SelectByCountryCodeResult item = Helper.Data.ngage_AddressCountryCodes_SelectByCountryCode('countryCode');
 

AddressCountryCodes_SelectById

Returns a address country and any associated information for the passed in id.

Properties

  • Id

Object Returned

ngage_AddressCountryCodes_SelectByIdResult
  • CountryCode (string)
  • CountryName (string)
  • Id (int)
  • NgageListValue (string)
  • Ordinal (int)
  • PostcodeRegex (string)
  • PostcodeSpace (int)
  • StateType (string)

Code Example

ngage_AddressCountryCodes_SelectByIdResult item = Helper.Data.ngage_AddressCountryCodes_SelectById('id');
 

AddressStates_SelectByCountryId

Returns a list of regions for the passed in country id.

Properties

  • Id

Object Returned

List<ngage_AddressStates_SelectByCountryIdResult>
  • CountryId (int)
  • CountryName (string)
  • Id (int)
  • PostcodeRegex (string)
  • StateAbbrev (string)
  • StateName (string)
  • StateType (string)

Code Example

List<ngage_AddressStates_SelectByCountryIdResult> item = Helper.Data.ngage_AddressStates_SelectByCountryId('id');
 

Advert_ByTypeId

Returns a list of advert items for the passed in tree id.

Properties

  • TypeId
  • TreeId

Object Returned

List<ngage_Advert_ByTypeIdResult>
  • AdvertId (long)
  • AssetTreeId (long)
  • IsActive (bool)
  • IsSiteWide (bool)
  • NavigationUrl (string)
  • RotationTimeMS (int)
  • Title (string)

Code Example

List<ngage_Advert_ByTypeIdResult> item = Helper.Data.ngage_Advert_ByTypeId('typeId','treeId');
 

Advert_ReportInsert

INTERNAL USE ONLY - Inserts advert report data, please use the advert handler "/adverts/treeId".

Properties

  • AdvertId
  • TreeId
  • IsClicked
  • IsLiveUrl

Object Returned

List<ngage_Advert_ReportInsertResult>
  • NavigationUrl (string)

Code Example

List<ngage_Advert_ReportInsertResult> item = Helper.Data.ngage_Advert_ReportInsert('advertId','treeId','isClicked','IsLiveUrl');
 

Asset_SelectByTreeId

Returns an 'AssetItem' object for the pased in tree id.

Properties

  • TreeId

Object Returned

AssetItem
  • AliasUrl (string)
  • AssetIconTreeId (long)
  • AssetId (long)
  • AssetsTypeId (long)
  • DateModified (datetime)
  • Description (string)
  • DisplayName (string)
  • FileName (string)
  • FolderLocation (string)
  • IsAssignedOnly (bool)
  • IsFolder (bool)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • NavigateUrl (string)
  • OriginalFileName (string)
  • ParentTreeId (long)
  • ThumbnailIsDifferent (bool)
  • TreeId (long)

Code Example

AssetItem item = Helper.Data.ngage_Asset_SelectByTreeId('treeId');
 

AssetBinary_ByTreeId

Returns a byte array of an asset for the passed in tree id.

Properties

  • TreeId

Object Returned

byte[]

Code Example

List<byte> item = Helper.Data.ngage_AssetBinary_ByTreeId('treeId');
 

AssetGallery_ByTreeId

Returns a list of 'AssetItem' for the passed in parent tree id.

Properties

  • TreeId
  • FoldersOnly
  • PageSize
  • CurrentPage
  • IsRecursive

Object Returned

List<AssetItem>
  • AliasUrl (string)
  • AssetIconTreeId (long)
  • AssetId (long)
  • AssetsTypeId (long)
  • DateModified (datetime)
  • Description (string)
  • DisplayName (string)
  • FileName (string)
  • FolderLocation (string)
  • IsAssignedOnly (bool)
  • IsFolder (bool)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • NavigateUrl (string)
  • OriginalFileName (string)
  • ParentTreeId (long)
  • ThumbnailIsDifferent (bool)
  • TreeId (long)

Code Example

List<AssetItem> item = Helper.Data.ngage_AssetGallery_ByTreeId('treeId','foldersOnly','pageSize','currentPage','isRecursive');
 

Assets_ByParentTreeId

Returns a list of 'AssetItem' objects for the passed in parent tree id.

Properties

  • TreeId
  • PageSize
  • CurrentPage

Object Returned

List<AssetItem>
  • AliasUrl (string)
  • AssetIconTreeId (long)
  • AssetId (long)
  • AssetsTypeId (long)
  • DateModified (datetime)
  • Description (string)
  • DisplayName (string)
  • FileName (string)
  • FolderLocation (string)
  • IsAssignedOnly (bool)
  • IsFolder (bool)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • NavigateUrl (string)
  • OriginalFileName (string)
  • ParentTreeId (long)
  • ThumbnailIsDifferent (bool)
  • TreeId (long)

Code Example

List<AssetItem> item = Helper.Data.ngage_Assets_ByParentTreeId('treeId','pageSize','currentPage');
 

Assets_ByStockId

Returns a list of 'AssetItem' objects for the passed in stock id.

Properties

  • StockId

Object Returned

List<ngage_Assets_ByStockIdResult>
  • AssetTreeId (long)
  • Description (string)
  • StockNo (string)
  • ToolTip (string)
  • Type (string)

Code Example

List<ngage_Assets_ByStockIdResult> item = Helper.Data.ngage_Assets_ByStockId('stockId');
 

Comments_Insert

Inserts a new review/comment for a page.

Properties

  • TreeId
  • Comments
  • Name
  • Email

Object Returned

ngage_Comments_InsertResult

Code Example

ngage_Comments_InsertResult item = Helper.Data.ngage_Comments_Insert('treeId','comments','name','email');
 

Comments_SelectByTreeId

Returns a list of reviews/comments for a page.

Properties

  • TreeId

Object Returned

List<ngage_Comments_SelectByTreeIdResult>
  • Comment (string)
  • DateCreated (datetime)
  • Email (string)
  • Id (long)
  • IsActive (bool)
  • Name (string)
  • TreeId (long)

Code Example

List<ngage_Comments_SelectByTreeIdResult> item = Helper.Data.ngage_Comments_SelectByTreeId('treeId');
 

DeliveryOptionCosts_SelectByDeliveryOptionId

Returns a delivery cost for the devilery option abnd weight.

Properties

  • DeliveryOptionId
  • WeightGramms

Object Returned

ngage_DeliveryOptionCosts_SelectByDeliveryOptionIdResult
  • Id (long)
  • OptionName (string)
  • UseWebService (bool)

Code Example

ngage_DeliveryOptionCosts_SelectByDeliveryOptionIdResult item = Helper.Data.ngage_DeliveryOptionCosts_SelectByDeliveryOptionId('deliveryOptionId','weightGramms');
 

DeliveryOptions_SelectBySiteId

Returns a list of delivery options for the passed in site id.

Properties

  • SizeIds
  • BasketWeight
  • CountryCode

Object Returned

List<ngage_DeliveryOptions_SelectBySiteIdResult>
  • Id (long)
  • IsPrimary (bool)
  • OptionName (string)
  • Ordinal (int)
  • TaxAllowed (bool)
  • UseWebService (bool)

Code Example

List<ngage_DeliveryOptions_SelectBySiteIdResult> item = Helper.Data.ngage_DeliveryOptions_SelectBySiteId('sizeIds','basketWeight','countryCode');
 

ECommerceBaskets_DeleteByUserId

Deletes all stored basket items for a user.

Properties

  • UserId

Object Returned

ngage_ECommerceBaskets_DeleteByUserIdResult
  • UserId (long)

Code Example

ngage_ECommerceBaskets_DeleteByUserIdResult item = Helper.Data.ngage_ECommerceBaskets_DeleteByUserId('userId');
 

ECommerceBaskets_DeleteByUserIdStockId

Deletes a users stored basket item.

Properties

  • UserId
  • StockId
  • ColourId
  • SizeId

Object Returned

ngage_ECommerceBaskets_DeleteByUserIdStockIdResult
  • UserId (long)

Code Example

ngage_ECommerceBaskets_DeleteByUserIdStockIdResult item = Helper.Data.ngage_ECommerceBaskets_DeleteByUserIdStockId('userId','stockId','colourId','sizeId');
 

ECommerceBaskets_SelectByUserId

Returns a list of stored basket items for a web user.

Properties

  • UserId

Object Returned

List<ngage_ECommerceBaskets_SelectByUserIdResult>
  • ColourId (long)
  • ColourName (string)
  • Description (string)
  • ExtraInfo (string)
  • IsDonation (bool)
  • Qty (int)
  • ShortDescription (string)
  • Size (string)
  • SizeId (long)
  • StockId (long)
  • StockNo (string)
  • Title (string)
  • VatExclusive (bool)
  • Weight (long)

Code Example

List<ngage_ECommerceBaskets_SelectByUserIdResult> item = Helper.Data.ngage_ECommerceBaskets_SelectByUserId('userId');
 

ECommerceBaskets_Update

Updates a web users basket with a new stock item/variation.

Properties

  • UserId
  • StockId
  • ColourId
  • SizeId
  • Qty
  • ExtraInfoValues

Object Returned

ngage_ECommerceBaskets_UpdateResult
  • StockId (long)

Code Example

ngage_ECommerceBaskets_UpdateResult item = Helper.Data.ngage_ECommerceBaskets_Update('userId','stockId','colourId','sizeId','qty','extraInfoValues');
 

ECommerceMerchants_Select_ByMerchantName

Returns a payment merchant for a the passed in merchant id.

Properties

  • MerchantNameMode

Object Returned

ngage_ECommerceMerchants_Select_ByMerchantNameResult
  • ButtonText (string)
  • Id (long)
  • MerchantDisplayImage (string)
  • MerchantName (string)
  • MerchantPassword (string)
  • MerchantPreSharedKey (string)
  • MerchantUrl (string)
  • MerchantUsername (string)

Code Example

ngage_ECommerceMerchants_Select_ByMerchantNameResult item = Helper.Data.ngage_ECommerceMerchants_Select_ByMerchantName('merchantNameMode');
 

ECommerceMerchants_Select_BySiteId

Returns a list of payment merchants for a website id.

Object Returned

List<ngage_ECommerceMerchants_Select_BySiteIdResult>
  • ButtonText (string)
  • Id (long)
  • MerchantDisplayImage (string)
  • MerchantName (string)
  • MerchantPassword (string)
  • MerchantPreSharedKey (string)
  • MerchantUrl (string)
  • MerchantUsername (string)

Code Example

List<ngage_ECommerceMerchants_Select_BySiteIdResult> item = Helper.Data.ngage_ECommerceMerchants_Select_BySiteId();
 

Emailing_Insert

Inserts a email record, emails are processed and sent out via the ngage windows service.

Properties

  • Subject
  • Content
  • EmailType
  • SendDate
  • EmailToAddress
  • EmailFromAddress
  • ReportsRequired
  • ViewviewInBrowserGuid
  • IsSecureConnection
  • BatchIdentifier
  • ReplyToAddress

Object Returned

ngage_Emailing_InsertResult

Code Example

ngage_Emailing_InsertResult item = Helper.Data.ngage_Emailing_Insert('subject','content','emailType','sendDate','emailToAddress','emailFromAddress','reportsRequired','viewviewInBrowserGuid','isSecureConnection','batchIdentifier','replyToAddress');
 

EmailingReports_Update

INTERNAL USE ONLY, used by the ngage hanlder to update click and open rates.

Properties

  • Id
  • UpdateType
  • EmailAddress

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_EmailingReports_Update('Id','updateType','emailAddress');
 

EmailingSelectByGuid

INTERNAL USE ONLY, used by the ngage handler to display a browser version '/view-in-browser/'.

Properties

  • Guid

Object Returned

ngage_EmailingSelectByGuidResult
  • Content (string)
  • EmailFromAddress (string)
  • EmailSentDate (datetime)
  • EmailToAddress (string)
  • EmailType (string)
  • Id (long)
  • IsSecureConnection (bool)
  • ReportsRequired (bool)
  • SendDate (datetime)
  • SendingGroup (int)
  • Subject (string)

Code Example

ngage_EmailingSelectByGuidResult item = Helper.Data.ngage_EmailingSelectByGuid('guid');
 

EmailingSelectById

INTERNAL USE ONLY, used by the ngage service to send out emails.

Properties

  • Id

Object Returned

ngage_EmailingSelectByIdResult
  • Content (string)
  • EmailFromAddress (string)
  • EmailToAddress (string)
  • EmailType (string)
  • Id (long)
  • IsSecureConnection (bool)
  • ReportsRequired (bool)
  • SendDate (datetime)
  • SendingGroup (int)
  • Subject (string)

Code Example

ngage_EmailingSelectByIdResult item = Helper.Data.ngage_EmailingSelectById('id');
 

EmailingTemplateSelectBySiteEnum

Returns an html email template for the passed in enumeration example ('forgotten-username').

Properties

  • Enumeration

Object Returned

ngage_EmailingTemplateSelectBySiteEnumResult
  • DefaultContent (string)
  • Enum (string)
  • HtmlContent (string)
  • Id (long)
  • IsSystemEmail (bool)
  • SiteId (long)
  • Subject (string)
  • Title (string)

Code Example

ngage_EmailingTemplateSelectBySiteEnumResult item = Helper.Data.ngage_EmailingTemplateSelectBySiteEnum('enumeration');
 

EmailingUnsubscribe_InsertUpdate

Unsubscribes a user from a mailing group.

Properties

  • EmailTypeId
  • EmailAddress
  • Unsubsrcibe
  • EmailGuid

Object Returned

ngage_EmailingUnsubscribe_InsertUpdateResult
  • EmailUpdated (string)

Code Example

ngage_EmailingUnsubscribe_InsertUpdateResult item = Helper.Data.ngage_EmailingUnsubscribe_InsertUpdate('emailTypeId','emailAddress','unsubsrcibe','EmailGuid');
 

ErrorLog_Insert

Inserts error information about any errors you wish to store from your websites.

Properties

  • ErrorContent: The content of the error (typically Exception.Message).
  • LoggedInUser: The logged in web user if any (WebUser.UserDisplayName).

Object Returned

bool

Code Example

Helper.Data.ngage_ErrorLog_Insert(ex.Message, WebUser.UserDisplayName);
 

ForumPostsInsert

Inserts a new post to a topic.

Properties

  • TopicId
  • Title
  • Description
  • UserId

Object Returned

List<ngage_ForumPostsInsertResult>

Code Example

List<ngage_ForumPostsInsertResult> item = Helper.Data.ngage_ForumPostsInsert('topicId','title','description','userId');
 

ForumPostsSelect_ById

Returns a forum post for the passed in post id.

Properties

  • PostId

Object Returned

List<ngage_ForumPostsSelect_ByIdResult>
  • DateCreated (datetime)
  • Description (string)
  • ForumTopicId (long)
  • Id (long)
  • Title (string)
  • UserId (string)

Code Example

List<ngage_ForumPostsSelect_ByIdResult> item = Helper.Data.ngage_ForumPostsSelect_ById('postId');
 

ForumPostsSelectAll

Returns a list of forum posts for the passed in topic id.

Properties

  • TopicId

Object Returned

List<ngage_ForumPostsSelectAllResult>
  • DateCreated (datetime)
  • Description (string)
  • ForumTopicId (long)
  • Id (long)
  • Title (string)
  • UserId (string)
  • UserPostCount (int)

Code Example

List<ngage_ForumPostsSelectAllResult> item = Helper.Data.ngage_ForumPostsSelectAll('topicId');
 

ForumsSelect_ById

Returns forum information for the passed in forum id.

Properties

  • ForumId

Object Returned

List<ngage_ForumsSelect_ByIdResult>
  • DateCreated (datetime)
  • Description (string)
  • ForumGroupId (long)
  • Id (long)
  • IsActive (bool)
  • Ordinal (int)
  • PostsReqAuth (bool)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • Title (string)
  • TopicsReqAuth (bool)

Code Example

List<ngage_ForumsSelect_ByIdResult> item = Helper.Data.ngage_ForumsSelect_ById('forumId');
 

ForumsSelectForumGroup_ById

Returns a list of forum groups for the passed in group id.

Properties

  • ForumGroupId

Object Returned

List<ngage_ForumsSelectForumGroup_ByIdResult>
  • DESCRIPTION (string)
  • ForumCount (int)
  • Id (long)
  • Title (string)

Code Example

List<ngage_ForumsSelectForumGroup_ByIdResult> item = Helper.Data.ngage_ForumsSelectForumGroup_ById('forumGroupId');
 

ForumsSelectForums

Returns forum item for the passed in group id.

Properties

  • ForumGroupId

Object Returned

List<ngage_ForumsSelectForumsResult>
  • DateCreated (datetime)
  • Description (string)
  • ForumGroupId (long)
  • Id (long)
  • IsActive (bool)
  • LastPostId (long)
  • Ordinal (int)
  • PostCount (int)
  • PostsReqAuth (bool)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • Title (string)
  • TopicCount (int)
  • TopicsReqAuth (bool)

Code Example

List<ngage_ForumsSelectForumsResult> item = Helper.Data.ngage_ForumsSelectForums('forumGroupId');
 

ForumsSelectTopics

Returns a list of forum topics for the passed in forum id.

Properties

  • ForumId

Object Returned

List<ngage_ForumsSelectTopicsResult>
  • DateCreated (datetime)
  • Description (string)
  • ForumId (long)
  • Id (long)
  • LastPostId (long)
  • PostCount (int)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • Title (string)

Code Example

List<ngage_ForumsSelectTopicsResult> item = Helper.Data.ngage_ForumsSelectTopics('forumId');
 

ForumTopicInsert

Inserts a new forum topic.

Properties

  • ForumId
  • Title
  • Description
  • PublishStartDate
  • PublishEndDate

Object Returned

List<ngage_ForumTopicInsertResult>

Code Example

List<ngage_ForumTopicInsertResult> item = Helper.Data.ngage_ForumTopicInsert('forumId','title','description','publishStartDate','publishEndDate');
 

ForumTopics_ById

Returns a forum topic for the passed in topic id.

Properties

  • TopicId

Object Returned

List<ngage_ForumTopics_ByIdResult>
  • DateCreated (datetime)
  • Description (string)
  • ForumId (long)
  • Id (long)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • Title (string)

Code Example

List<ngage_ForumTopics_ByIdResult> item = Helper.Data.ngage_ForumTopics_ById('topicId');
 

Languages_SelectBySiteId

Returns a list of valid in use languages for a website.

Properties

  • IsPrimaryOnly

Object Returned

List<ngage_Languages_SelectBySiteIdResult>
  • Code (string)
  • Id (int)
  • Name (string)

Code Example

List<ngage_Languages_SelectBySiteIdResult> item = Helper.Data.ngage_Languages_SelectBySiteId('isPrimaryOnly');
 

Marketing_Insert

Creates a record in the marketing table and returns the newly created id.

Properties

  • Firstname
  • Surname
  • Email
  • Mobile

Object Returned

List<ngage_Marketing_InsertResult>
  • Result (long)

Code Example

List<ngage_Marketing_InsertResult> item = Helper.Data.ngage_Marketing_Insert('firstname','surname','email','mobile');
 

MediaPlayLists_SelectAll

Returns a list of all embeded media items.

Object Returned

List<ngage_MediaPlayLists_SelectAllResult>
  • PlayListTreeId (long)
  • Title (string)

Code Example

List<ngage_MediaPlayLists_SelectAllResult> item = Helper.Data.ngage_MediaPlayLists_SelectAll();
 

MediaPlayLists_SelectByTreeId

Returns an embeded media item for the passed in tree id.

Properties

  • TreeId

Object Returned

List<ngage_MediaPlayLists_SelectByTreeIdResult>
  • Description (string)
  • EmbedCode (string)
  • Title (string)
  • TreeId (long)

Code Example

List<ngage_MediaPlayLists_SelectByTreeIdResult> item = Helper.Data.ngage_MediaPlayLists_SelectByTreeId('treeId');
 

MediaPlayLists_SelectItems

Returns an embeded media item for the passed in playlist id.

Properties

  • PlaylistTreeId

Object Returned

List<ngage_MediaPlayLists_SelectItemsResult>
  • Description (string)
  • EmbedCode (string)
  • Title (string)
  • TreeId (long)

Code Example

List<ngage_MediaPlayLists_SelectItemsResult> item = Helper.Data.ngage_MediaPlayLists_SelectItems('playlistTreeId');
 

MenuItems_Select_ByMenuId

Returns a list of menu items (internal & external url links) for the passed in parent menu id.

Properties

  • MenuId

Object Returned

List<ngage_MenuItems_Select_ByMenuIdResult>
  • DisplayText (string)
  • Id (long)
  • IsExternalLink (bool)
  • MenuId (long)
  • MenuName (string)
  • UrlLink (string)

Code Example

List<ngage_MenuItems_Select_ByMenuIdResult> item = Helper.Data.ngage_MenuItems_Select_ByMenuId('menuId');
 

MetaData_SelectByTreeId

Returns a meta data item for the passed in tree id and meta name.

Properties

  • TreeId
  • MetaName

Object Returned

ngage_MetaData_SelectByTreeIdResult
  • DataType (string)
  • DataValue (string)
  • DateModified (datetime)
  • HtmlValue (string)
  • MetaDataName (string)
  • MetaDisplayLabel (string)
  • MetaItemId (long)
  • MetaValue (string)
  • TreeId (long)

Code Example

ngage_MetaData_SelectByTreeIdResult item = Helper.Data.ngage_MetaData_SelectByTreeId('treeId','metaName');
 

MetaDataItems_SelectByTreeId

Returns a list of meta data items for the passed in tree id.

Properties

  • TreeId

Object Returned

List<ngage_MetaDataItems_SelectByTreeIdResult>
  • DataType (string)
  • DataValue (string)
  • DateModified (datetime)
  • HtmlValue (string)
  • MetaDataName (string)
  • MetaDisplayLabel (string)
  • MetaItemId (long)
  • MetaValue (string)
  • TreeId (long)

Code Example

List<ngage_MetaDataItems_SelectByTreeIdResult> item = Helper.Data.ngage_MetaDataItems_SelectByTreeId('treeId');
 

MetaItems_Select_ByPageTemplateId

Returns a list of meta data items for the passed in page template id.

Properties

  • PageTemplateId

Object Returned

List<ngage_MetaItems_Select_ByPageTemplateIdResult>
  • ClassItem (string)
  • Id (long)
  • IsRequired (bool)
  • MetaName (string)

Code Example

List<ngage_MetaItems_Select_ByPageTemplateIdResult> item = Helper.Data.ngage_MetaItems_Select_ByPageTemplateId('pageTemplateId');
 

Navigation_Select

Returns a list of navigation items for the parent Tree Id passed in.

Properties

  • ParentId: The id of the parent tree (zero will return the top level navigation for the website).
  • NavigationLevels: The amount of child levels to return (zero will return the top level only).

Object Returned

List<ngage_Navigation_SelectResult>
  • Id (long): The Database Id of the item
  • TreeId (long): The Tree Id of the item
  • Title (string): The display title
  • AliasUrl (string): The navigational URL
  • HasChildren (bool): If the item has any children
  • CreatedDate (datetime): The date time the item was created
  • IsClickable (bool): If the navigation item should have the mouse click enabled (typically used when hover over menus are in place)
  • Ordinal (int): The order to display the items
  • ParentId (long): The Database Parent Id of the item
  • NavLevel (int): The child level the item belongs to
  • DateModified (datetime): The date the item was last modified (usually when a tree item has been renamed)
  • IsNavigation (bool): If the item should be displayed or hidden in the main navigation

Code Example

List<ngage_Navigation_SelectResult> items = Helper.Data.ngage_Navigation_Select(0, 2);
 

Navigation_SelectByParent

Returns a list of navigation items for the parent Tree Id passed in.

Properties

  • ParentId: The id of the parent tree (zero will return the top level navigation for the website).

Object Returned

List<ngage_Navigation_SelectByParentResult>
  • Id (long): The Database Id of the item
  • TreeId (long): The Tree Id of the item
  • Title (string): The display title
  • AliasUrl (string): The navigational URL
  • HasChildren (bool): If the item has any children
  • CreatedDate (datetime): The date time the item was created
  • IsClickable (bool): If the navigation item should have the mouse click enabled (typically used when hover over menus are in place)

Code Example

List<ngage_Navigation_SelectByParentResult> items = Helper.Data.ngage_Navigation_SelectByParent(0);
 

Order_Dispatched

Updates an order status to dispatched and inserts any tracking information.

Properties

  • OrderId
  • TrackingCode
  • TrackingUrl
  • LoggedInUser

Object Returned

int

Code Example

int item = Helper.Data.ngage_Order_Dispatched('orderId','trackingCode','trackingUrl','loggedInUser');
 

Order_InvoiceByOrderId

Returns an an invoice in a html string format for the passed in invoice id.

Properties

  • OrderId
  • IsDeliveryNote
  • EmailTemplateId

Object Returned

ngage_Order_InvoiceByOrderIdResult
  • Invoice (string)

Code Example

ngage_Order_InvoiceByOrderIdResult item = Helper.Data.ngage_Order_InvoiceByOrderId('orderId','isDeliveryNote','emailTemplateId');
 

Order_SelectByUserId

Returns a order for the passed web user id.

Properties

  • UserId

Object Returned

List<ngage_Order_SelectByUserIdResult>
  • CreatedBy (string)
  • DateCreated (datetime)
  • DelAddressLineOne (string)
  • DelAddressLineTwo (string)
  • DelBusinessName (string)
  • DelCountry (string)
  • DelCountryCode (string)
  • DelCounty (string)
  • DelFirstName (string)
  • DelPostcode (string)
  • DelSurname (string)
  • DelTown (string)
  • DeliveryTrackingCode (string)
  • DeliveryTrackingUrl (string)
  • DeliveryType (string)
  • DispatchDate (datetime)
  • ExtraInfoFieldOne (string)
  • ExtraInfoFieldTwo (string)
  • ForeignOrderId (string)
  • Id (long)
  • OrderStatus (string)
  • OrderType (string)
  • PaymentRef (string)
  • PromoCodeUsed (string)
  • UserFirstname (string)
  • UserForeignId (string)
  • UserId (long)
  • UserMobile (string)
  • UserSurname (string)
  • UsersEmailAddress (string)

Code Example

List<ngage_Order_SelectByUserIdResult> item = Helper.Data.ngage_Order_SelectByUserId('userId');
 

OrderDelete

Marks the order as deleted for the Order Id passed in.

Properties

  • OrderId: The id of the order to mark as deleted.

Object Returned

bool

Code Example

bool result = Helper.Data.ngage_OrderDelete(200);
 

OrderInsert

Inserts a new order, any order items need to be entered by using 'ngage_OrderItemsInsert'.

Properties

  • UserId
  • DeliveryType
  • SubTotal
  • Discount
  • FaceValueDiscount
  • Tax
  • Delivery
  • Total
  • BillingFirstName
  • BillingSurname
  • BillingBusinessName
  • BillingAddressLineOne
  • BillingAddressLineTwo
  • BillingTown
  • BillingCounty
  • BillingCountry
  • BillingCountryCode
  • BillingPostcode
  • DeliveryFirstName
  • DeliverySurname
  • DeliveryBusinessName
  • DeliveryAddressLineOne
  • DeliveryAddressLineTwo
  • DeliveryTown
  • DeliveryCounty
  • DeliveryCountry
  • DeliveryCountryCode
  • DeliveryPostcode
  • OrderType
  • PromoCodeUsed
  • CreatedBy
  • OrderId
  • PaymentType
  • CustomerReference
  • Notes
  • ForeignOrderId
  • ExtraInfoFieldOne
  • ExtraInfoFieldTwo

Object Returned

ngage_OrderInsertResult
  • IsAccountCustomer (bool)
  • OrderId (long)

Code Example

ngage_OrderInsertResult item = Helper.Data.ngage_OrderInsert('userId','deliveryType','subTotal','discount','faceValueDiscount','tax','delivery','total','billingFirstName','billingSurname','billingBusinessName','billingAddressLineOne','billingAddressLineTwo','billingTown','billingCounty','billingCountry','billingCountryCode','billingPostcode','deliveryFirstName','deliverySurname','deliveryBusinessName','deliveryAddressLineOne','deliveryAddressLineTwo','deliveryTown','deliveryCounty','deliveryCountry','deliveryCountryCode','deliveryPostcode','orderType','promoCodeUsed','createdBy','orderId','paymentType','customerReference','notes','foreignOrderId','extraInfoFieldOne','extraInfoFieldTwo');
 

OrderItemsInsert

Inserts order line items to an existing order, insert an order by using 'ngage_OrderInsert'.

Properties

  • OrderId
  • StockCode
  • StockTitle
  • Qty
  • UnitCostPaid
  • ManageStockLevel
  • IsDonation
  • UnitTaxPaid
  • StockColour
  • StockSize
  • StockSizeId
  • StockColourId
  • ExtraInfoValues
  • OrderOrigin
  • ForeignOrderItemId

Object Returned

ngage_OrderItemsInsertResult

Code Example

ngage_OrderItemsInsertResult item = Helper.Data.ngage_OrderItemsInsert('orderId','stockCode','stockTitle','qty','unitCostPaid','manageStockLevel','isDonation','unitTaxPaid','stockColour','stockSize','stockSizeId','stockColourId','extraInfoValues','orderOrigin','foreignOrderItemId');
 

OrderItemsSelectByOrderId

Returns a list of order items for the passed in order id.

Properties

  • OrderId

Object Returned

List<ngage_OrderItemsSelectByOrderIdResult>
  • BinLocation (string)
  • ForeignOrderItemId (string)
  • Id (long)
  • IsDonation (bool)
  • ManufacturerId (long)
  • OrderId (long)
  • Qty (int)
  • QtyShipped (int)
  • ReturnedOrderIds (string)
  • ReturnedOrderQty (int)
  • StockCode (string)
  • StockColour (string)
  • StockSize (string)
  • StockSizeId (long)
  • StockTitle (string)

Code Example

List<ngage_OrderItemsSelectByOrderIdResult> item = Helper.Data.ngage_OrderItemsSelectByOrderId('orderId');
 

OrderSelectById

Returns a order for the passed in order id, pass in a user id to validate the order belongs to a particular web user.

Properties

  • OrderId
  • UserId

Object Returned

ngage_OrderSelectByIdResult
  • BilAddressLineOne (string)
  • BilAddressLineTwo (string)
  • BilBusinessName (string)
  • BilCountry (string)
  • BilCountryCode (string)
  • BilCounty (string)
  • BilFirstName (string)
  • BilPostcode (string)
  • BilSurname (string)
  • BilTown (string)
  • CreatedBy (string)
  • DateCreated (datetime)
  • DelAddressLineOne (string)
  • DelAddressLineTwo (string)
  • DelBusinessName (string)
  • DelCountry (string)
  • DelCountryCode (string)
  • DelCounty (string)
  • DelFirstName (string)
  • DelPostcode (string)
  • DelSurname (string)
  • DelTown (string)
  • DeliveryTrackingCode (string)
  • DeliveryTrackingUrl (string)
  • DeliveryType (string)
  • DispatchDate (datetime)
  • DispatchLabels (string)
  • ExtraInfoFieldOne (string)
  • ExtraInfoFieldTwo (string)
  • ForeignOrderId (string)
  • Id (long)
  • OrderStatus (string)
  • OrderType (string)
  • PaymentRef (string)
  • PromoCodeUsed (string)
  • UserFirstname (string)
  • UserForeignId (string)
  • UserId (long)
  • UserMobile (string)
  • UserSurname (string)
  • UsersEmailAddress (string)

Code Example

ngage_OrderSelectByIdResult item = Helper.Data.ngage_OrderSelectById('orderId','userId');
 

OrderUpdateExtraInfoFields

Update the custom free text feilds, with any custom information.

Properties

  • OrderId
  • ExtraInfoFieldOne
  • ExtraInfoFieldTwo

Object Returned

ngage_OrderUpdateExtraInfoFieldsResult
  • DateCreated (datetime)
  • DateUpdated (datetime)
  • DeliveryTrackingCode (string)
  • DeliveryTrackingUrl (string)
  • DeliveryType (string)
  • ExtraInfoFieldOne (string)
  • ExtraInfoFieldTwo (string)
  • Id (long)
  • MerchantStatus (string)
  • OrderType (string)
  • PaymentRef (string)
  • SiteId (long)
  • StatusId (int)
  • UserId (long)

Code Example

ngage_OrderUpdateExtraInfoFieldsResult item = Helper.Data.ngage_OrderUpdateExtraInfoFields('orderId','extraInfoFieldOne','extraInfoFieldTwo');
 

OrderUpdateStatus

Update an order status, add the merchant status to display any merchant errors.

Properties

  • OrderId
  • StatusId
  • PaymentRef
  • MerchantStatus

Object Returned

List<ngage_OrderUpdateStatusResult>
  • UsersEmail (string)
  • UsersId (long)

Code Example

List<ngage_OrderUpdateStatusResult> item = Helper.Data.ngage_OrderUpdateStatus('orderId','statusId','paymentRef','merchantStatus');
 

PageEvents_Select

Returns a list of events for the passed in tree id.

Properties

  • ParentTreeId
  • Logitude
  • Latitude
  • Radius
  • MeasurementType
  • EventDateFrom
  • EventDateTo

Object Returned

List<ngage_PageEvents_SelectResult>
  • DateModified (datetime)
  • Discount (string)
  • EventEndDate (datetime)
  • EventStartDate (datetime)
  • IsMembersOnly (bool)
  • ListingImageTreeId (string)
  • Location (string)
  • RevisionId (long)
  • Tags (string)
  • Teaser (string)
  • Title (string)
  • TreeId (long)
  • UrlAlias (string)

Code Example

List<ngage_PageEvents_SelectResult> item = Helper.Data.ngage_PageEvents_Select('parentTreeId','logitude','latitude','radius','measurementType','eventDateFrom','eventDateTo');
 

Pages_SearchEngineExludeList

INTERNAL USE ONLY, used for the handler robots.txt.

Object Returned

List<ngage_Pages_SearchEngineExcludeListResult>
  • Id (long)
  • UrlAlias (string)
  • rownum (long)

Code Example

List<ngage_Pages_SearchEngineExcludeListResult> item = Helper.Data.ngage_Pages_SearchEngineExludeList();
 

Pages_SearchEngineXml

Returns page information in xml format for the passed in parent tree id.

Properties

  • ParentId
  • Levels

Object Returned

List<ngage_Pages_SearchEngineXmlResult>
  • AliasUrl (string)
  • CreatedDate (datetime)
  • HasChildren (bool)
  • Id (long)
  • IsClickable (bool)
  • NavLevel (int)
  • ParentId (long)
  • Title (string)
  • TreeId (long)

Code Example

List<ngage_Pages_SearchEngineXmlResult> item = Helper.Data.ngage_Pages_SearchEngineXml('parentId','levels');
 

Pages_SelectAllBySiteId

Returns a list of 'PageItem' objects for a particular website.

Properties

  • SiteId
  • ItemIndex
  • ItemCount
  • TagList
  • OrderBy

Object Returned

List<PageItem>
  • AliasUrl (string)
  • AssetTreeId (long)
  • CanonicalUrl (string)
  • Content (string)
  • CreatedBy (string)
  • CreatedDate (datetime)
  • DateModified (datetime)
  • DisplayTitle (string)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • MasterPageFile (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • PageId (long)
  • PageTemplate (string)
  • ParentTreeId (long)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • RevisionId (long)
  • RootTreeId (long)
  • Teaser (string)
  • TemplateType (string)
  • Title (string)
  • TreeId (long)

Code Example

List<PageItem> item = Helper.Data.ngage_Pages_SelectAllBySiteId('siteId','itemIndex','itemCount','tagList','orderBy');
 

Pages_SelectArchive_ByTreeId

Returns a list of pages that have been archived for the passed in parent tree id.

Properties

  • ParentId

Object Returned

List<ngage_Pages_SelectArchive_ByTreeIdResult>
  • ArchiveDate (datetime)
  • ArchiveMonth (int)
  • ArchiveYear (int)

Code Example

List<ngage_Pages_SelectArchive_ByTreeIdResult> item = Helper.Data.ngage_Pages_SelectArchive_ByTreeId('parentId');
 

Pages_SelectChildrenCurrentRevision_ByTreeId

Returns a list of 'PageItem' objects.

Properties

  • TreeId
  • ItemIndex
  • ItemCount
  • TagList
  • ArchiveMonth
  • OrderBy

Object Returned

List<PageItem>
  • AliasUrl (string)
  • AssetTreeId (long)
  • CanonicalUrl (string)
  • Content (string)
  • CreatedBy (string)
  • CreatedDate (datetime)
  • DateModified (datetime)
  • DisplayTitle (string)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • MasterPageFile (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • PageId (long)
  • PageTemplate (string)
  • ParentTreeId (long)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • RevisionId (long)
  • RootTreeId (long)
  • Teaser (string)
  • TemplateType (string)
  • Title (string)
  • TreeId (long)

Code Example

List<PageItem> item = Helper.Data.ngage_Pages_SelectChildrenCurrentRevision_ByTreeId('treeId','itemIndex','itemCount','tagList','archiveMonth','orderBy');
 

Pages_SelectChildrenCurrentRevision_ByTreeIds

Returns a list of 'PageItem' objects for the passed in tree ids.

Properties

  • TreeIds
  • ItemIndex
  • ItemCount
  • TagList
  • ArchiveMonth
  • OrderBy

Object Returned

List<PageItem>
  • AliasUrl (string)
  • AssetTreeId (long)
  • CanonicalUrl (string)
  • Content (string)
  • CreatedBy (string)
  • CreatedDate (datetime)
  • DateModified (datetime)
  • DisplayTitle (string)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • MasterPageFile (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • PageId (long)
  • PageTemplate (string)
  • ParentTreeId (long)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • RevisionId (long)
  • RootTreeId (long)
  • Teaser (string)
  • TemplateType (string)
  • Title (string)
  • TreeId (long)

Code Example

List<PageItem> item = Helper.Data.ngage_Pages_SelectChildrenCurrentRevision_ByTreeIds('treeIds','itemIndex','itemCount','tagList','archiveMonth','orderBy');
 

Pages_SelectCurrentRevision_ByTreeId

Returns a 'PageItem' object for the passed in tree id.

Properties

  • TreeId: The trees Database Id.

Object Returned

PageItem
  • RevisionId (long)
  • Content (string)
  • PageId (long)
  • PublishStartDate (datetime)
  • PublishEndDate (datetime)
  • TemplateType (string)
  • CreatedDate (datetime)
  • CreatedBy (string)
  • Teaser (string)
  • Title (string)
  • DisplayTitle (string)
  • PageTemplate (string)
  • MetaTitle (string)
  • MetaDescription (string)
  • IsMembersOnly (bool)
  • MasterPageFile (string)
  • AliasUrl (string)
  • RootTreeId (long)
  • CanonicalUrl (string)
  • TreeId (long)
  • DateModified (datetime)
  • AssetTreeId (long)
  • ParentTreeId (long)
  • ItemCount (int)

Code Example

PageItem item = Helper.Data.ngage_Pages_SelectCurrentRevision_ByTreeId('treeId');
 

Pages_SelectCurrentRevision_ByTreeIds

Returns a list of 'PageItem' objects for the passed in tree ids.

Properties

  • TreeIds

Object Returned

List<PageItem>
  • AliasUrl (string)
  • AssetTreeId (long)
  • CanonicalUrl (string)
  • Content (string)
  • CreatedBy (string)
  • CreatedDate (datetime)
  • DateModified (datetime)
  • DisplayTitle (string)
  • IsMembersOnly (bool)
  • ItemCount (int)
  • MasterPageFile (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • PageId (long)
  • PageTemplate (string)
  • ParentTreeId (long)
  • PublishEndDate (datetime)
  • PublishStartDate (datetime)
  • RevisionId (long)
  • RootTreeId (long)
  • Teaser (string)
  • TemplateType (string)
  • Title (string)
  • TreeId (long)

Code Example

List<PageItem> item = Helper.Data.ngage_Pages_SelectCurrentRevision_ByTreeIds('treeIds');
 

PageTemplates_SelectAll

Returns a list of all cms page templates (MVC or ASP.Net).

Object Returned

List<ngage_PageTemplates_SelectAllResult>
  • AliasExcludeName (string)
  • FileLocation (string)
  • Id (long)
  • Title (string)

Code Example

List<ngage_PageTemplates_SelectAllResult> item = Helper.Data.ngage_PageTemplates_SelectAll();
 

PageTemplates_SelectBySiteId

Returns a list of all cms page templates for the current website (MVC or ASP.Net).

Object Returned

List<ngage_PageTemplates_SelectBySiteIdResult>
  • AliasExcludeName (string)
  • FileLocation (string)
  • Id (long)
  • Title (string)

Code Example

List<ngage_PageTemplates_SelectBySiteIdResult> item = Helper.Data.ngage_PageTemplates_SelectBySiteId();
 

PromoCode_SelectCert

Returns a string of HTML which contains the printable/displayable gift certificate, used when displaying a certificate from a web users email account.

Properties

  • EmailGuid: The Guid of promo code sent in the email to a web user.

Object Returned

ngage_PromoCode_SelectCertResult
  • Html (string): A string of HTML

Code Example

ngage_PromoCode_SelectCertResult certInfo = Helper.Data.ngage_PromoCode_SelectCert("Guid-Here");
 

PromoCode_SelectSystemByStockId

Returns any valid system promotion codes for a web users basket.

Properties

  • StockIdList
  • PromoCodeEntered

Object Returned

ngage_PromoCode_SelectSystemByStockIdResult
  • DisplayText (string)
  • IsFaceValue (bool)
  • MediaValue (string)
  • PromoCode (string)
  • PromoCodeMediaEnum (string)

Code Example

ngage_PromoCode_SelectSystemByStockIdResult item = Helper.Data.ngage_PromoCode_SelectSystemByStockId('stockIdList','promoCodeEntered');
 

PromoCode_SelectSystemCodes

Returns a list of system promo codes for a website.

Object Returned

List<ngage_PromoCode_SelectSystemCodesResult>
  • DisplayText (string)
  • MediaValue (string)
  • Priority (int)
  • PromoCode (string)

Code Example

List<ngage_PromoCode_SelectSystemCodesResult> item = Helper.Data.ngage_PromoCode_SelectSystemCodes();
 

PromoCode_UserCodeValidate

Validates a promo codes entered by a web user at checkout.

Properties

  • PromoCodeEntered
  • IsDesktopApp

Object Returned

ngage_PromoCode_UserCodeValidateResult
  • DisplayText (string)
  • Enum (string)
  • InConjuctionWith (string)
  • MediaValue (string)
  • Priority (int)
  • PromoCode (string)
  • PromoCodeTypeId (int)

Code Example

ngage_PromoCode_UserCodeValidateResult item = Helper.Data.ngage_PromoCode_UserCodeValidate('promoCodeEntered','isDesktopApp');
 

Site_Select_ById

Returns website settings data for a particular website.

Object Returned

ngage_Site_Select_ByIdResult
  • BasketDescription (string): A description of the shopping basket, used as a display title when payment is transferred to a merchant account
  • CategoryDisplayAmount (int): Amount of items to display when listing category
  • Currency (string): Default currency of the website (GBP)
  • CurrencyDisplayCode (string): HTML currency display code
  • Id (long): Database Id
  • InvoiceFooter (string): HTML invoice footer content
  • MasterPageScripts (string): Custom JavaScript code, usually added to the head section of a Master Page
  • ProductDisplayAmount (int): Amount of items to display when listing products
  • SiteEmail (string): Default email, generally used as the send from email address
  • SiteLocation (string): If true the item is members only
  • SiteName (string): Display name of the website
  • SiteTreeId (long): Tree Id of the website
  • SiteUrl (string): URL of the website
  • TaxLabel (string): Display HTML tax label (VAT)
  • TaxAmount (double): Amount of tax to apply, usually at checkout

Code Example

ngage_Site_Select_ByIdResult siteItem = Helper.Data.ngage_Site_Select_ById();
 

Site_Select_ByTreeId

No longer used.

Properties

  • ChildId
  • Level

Object Returned

ngage_Site_Select_ByTreeIdResult
  • AliasDefaultPage (string)
  • CmsStyleSheetUrl (string)
  • Id (long)
  • RevsionSaveAmount (int)
  • SiteEmail (string)
  • SiteName (string)
  • SitePreviewUrl (string)
  • SiteTreeId (long)
  • SiteUrl (string)

Code Example

ngage_Site_Select_ByTreeIdResult item = Helper.Data.ngage_Site_Select_ByTreeId('childId','level');
 

Stock_ByCategoryTreeId

Returns a list of 'StockItem' objects for the passed in tree id.

Properties

  • TreeId
  • MinPriceFilter
  • MaxPriceFilter
  • ManufacturerIdFilter
  • DisplayType
  • StockNoList

Object Returned

List<StockItem>
  • AliasUrl (string)
  • AssetTreeId (long)
  • AvailableDate (datetime)
  • ChildTreeIds (string)
  • ColourLabel (string)
  • CustomFilterIds (string)
  • DateCreated (datetime)
  • DateModified (datetime)
  • Description (string)
  • DisplayImageGallery (bool)
  • ExtraInfo (string)
  • IsActive (bool)
  • ManufacturerId (long)
  • ManufacturerName (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • MinWeight (long)
  • Ordinal (int)
  • ParentTreeId (long)
  • ShortDescription (string)
  • SizeLabel (string)
  • Specifications (string)
  • StockAllocated (int)
  • StockId (long)
  • StockLevel (int)
  • StockNo (string)
  • Title (string)
  • TreeId (long)

Code Example

List<StockItem> item = Helper.Data.ngage_Stock_ByCategoryTreeId('treeId','minPriceFilter','maxPriceFilter','manufacturerIdFilter','displayType','stockNoList');
 

Stock_ById

Returns a list of 'StockItem' objects for the passed in stock id.

Properties

  • RootStockTreeId
  • StockId

Object Returned

StockItem
  • AliasUrl (string)
  • AssetTreeId (long)
  • AvailableDate (datetime)
  • ChildTreeIds (string)
  • ColourLabel (string)
  • CustomFilterIds (string)
  • DateCreated (datetime)
  • DateModified (datetime)
  • Description (string)
  • DisplayImageGallery (bool)
  • ExtraInfo (string)
  • IsActive (bool)
  • ManufacturerId (long)
  • ManufacturerName (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • MinWeight (long)
  • Ordinal (int)
  • ParentTreeId (long)
  • ShortDescription (string)
  • SizeLabel (string)
  • Specifications (string)
  • StockAllocated (int)
  • StockId (long)
  • StockLevel (int)
  • StockNo (string)
  • Title (string)
  • TreeId (long)

Code Example

StockItem item = Helper.Data.ngage_Stock_ById('rootStockTreeId','stockId');
 

Stock_ByStockNo

Returns a list of 'StockItem' objects for the passed in stock number (sku).

Properties

  • RootStockTreeId
  • StockNo

Object Returned

StockItem
  • AliasUrl (string)
  • AssetTreeId (long)
  • AvailableDate (datetime)
  • ChildTreeIds (string)
  • ColourLabel (string)
  • CustomFilterIds (string)
  • DateCreated (datetime)
  • DateModified (datetime)
  • Description (string)
  • DisplayImageGallery (bool)
  • ExtraInfo (string)
  • IsActive (bool)
  • ManufacturerId (long)
  • ManufacturerName (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • MinWeight (long)
  • Ordinal (int)
  • ParentTreeId (long)
  • ShortDescription (string)
  • SizeLabel (string)
  • Specifications (string)
  • StockAllocated (int)
  • StockId (long)
  • StockLevel (int)
  • StockNo (string)
  • Title (string)
  • TreeId (long)

Code Example

StockItem item = Helper.Data.ngage_Stock_ByStockNo('rootStockTreeId','stockNo');
 

Stock_ByTreeId

Returns a list of 'StockItem' objects for the parent tree id.

Properties

  • TreeId

Object Returned

StockItem
  • AliasUrl (string)
  • AssetTreeId (long)
  • AvailableDate (datetime)
  • ChildTreeIds (string)
  • ColourLabel (string)
  • CustomFilterIds (string)
  • DateCreated (datetime)
  • DateModified (datetime)
  • Description (string)
  • DisplayImageGallery (bool)
  • ExtraInfo (string)
  • IsActive (bool)
  • ManufacturerId (long)
  • ManufacturerName (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • MinWeight (long)
  • Ordinal (int)
  • ParentTreeId (long)
  • ShortDescription (string)
  • SizeLabel (string)
  • Specifications (string)
  • StockAllocated (int)
  • StockId (long)
  • StockLevel (int)
  • StockNo (string)
  • Title (string)
  • TreeId (long)

Code Example

StockItem item = Helper.Data.ngage_Stock_ByTreeId('treeId');
 

Stock_SelectAll

Returns a list of all stock items, after a passed in date, used in a caching scenario.

Properties

  • Since

Object Returned

List<ngage_Stock_SelectAllResult>
  • AliasUrl (string)
  • BarCode (string)
  • Checksum (int)
  • ColourId (long)
  • ColourName (string)
  • ColourValue (string)
  • Description (string)
  • DisplayImageGallery (bool)
  • IsDonation (bool)
  • ManufacturerId (long)
  • ParentTreeId (long)
  • ShortDescription (string)
  • SiteId (long)
  • Size (string)
  • SizeId (long)
  • StockAllocated (int)
  • StockAssetTreeId (long)
  • StockId (long)
  • StockLevel (int)
  • StockNo (string)
  • Title (string)
  • TreeId (long)
  • VatExclusive (int)
  • Weight (long)

Code Example

List<ngage_Stock_SelectAllResult> item = Helper.Data.ngage_Stock_SelectAll('since');
 

Stock_SelectAllProducts

Returns all stock items.

Properties

  • RootStockTreeId

Object Returned

List<StockItem>
  • AliasUrl (string)
  • AssetTreeId (long)
  • AvailableDate (datetime)
  • ChildTreeIds (string)
  • ColourLabel (string)
  • CustomFilterIds (string)
  • DateCreated (datetime)
  • DateModified (datetime)
  • Description (string)
  • DisplayImageGallery (bool)
  • ExtraInfo (string)
  • IsActive (bool)
  • ManufacturerId (long)
  • ManufacturerName (string)
  • MetaDescription (string)
  • MetaTitle (string)
  • MinWeight (long)
  • Ordinal (int)
  • ParentTreeId (long)
  • ShortDescription (string)
  • SizeLabel (string)
  • Specifications (string)
  • StockAllocated (int)
  • StockId (long)
  • StockLevel (int)
  • StockNo (string)
  • Title (string)
  • TreeId (long)

Code Example

List<StockItem> item = Helper.Data.ngage_Stock_SelectAllProducts('rootStockTreeId');
 

StockCategory_ById

Returns a items of a stock category for the passed in tree id.

Properties

  • TreeId

Object Returned

ngage_StockCategory_ByIdResult
  • Description (string)
  • DisplayTitle (string)
  • IsNavigation (bool)
  • Title (string)

Code Example

ngage_StockCategory_ByIdResult item = Helper.Data.ngage_StockCategory_ById('treeId');
 

StockCategory_ByTreeId

Returns a list of a stock categories for the passed in parent tree id.

Properties

  • TreeId

Object Returned

List<ngage_StockCategory_ByTreeIdResult>
  • AliasUrl (string)
  • AssetTreeId (long)
  • DateModified (datetime)
  • Description (string)
  • HasChildren (bool)
  • Id (long)
  • Title (string)

Code Example

List<ngage_StockCategory_ByTreeIdResult> item = Helper.Data.ngage_StockCategory_ByTreeId('treeId');
 

StockCategoryChildren_ByTreeId

Returns a list of stock categories for the parent tree id.

Properties

  • TreeId

Object Returned

List<ngage_StockCategoryChildren_ByTreeIdResult>
  • AliasUrl (string)
  • AssetTreeId (long)
  • DateModified (datetime)
  • Description (string)
  • DisplayTitle (string)
  • HasChildren (bool)
  • Id (long)
  • IsNavigation (bool)
  • Title (string)

Code Example

List<ngage_StockCategoryChildren_ByTreeIdResult> item = Helper.Data.ngage_StockCategoryChildren_ByTreeId('treeId');
 

StockColours_ById

Returns a variation one item for the passed in variation one id.

Properties

  • ColourId

Object Returned

ngage_StockColours_ByIdResult
  • ColourName (string)
  • Id (long)
  • StockId (long)

Code Example

ngage_StockColours_ByIdResult item = Helper.Data.ngage_StockColours_ById('colourId');
 

StockColours_ByStockId

Returns a list of variation one items for the passed in stock id.

Properties

  • StockId

Object Returned

List<ngage_StockColours_ByStockIdResult>
  • ColourName (string)
  • DateModified (datetime)
  • Id (long)
  • Ordinal (int)
  • StockId (long)

Code Example

List<ngage_StockColours_ByStockIdResult> item = Helper.Data.ngage_StockColours_ByStockId('stockId');
 

StockFilters_Select

Returns a stock filters for the current website.

Object Returned

List<ngage_StockFilters_SelectResult>
  • Group (string)
  • Id (long)
  • Title (string)

Code Example

List<ngage_StockFilters_SelectResult> item = Helper.Data.ngage_StockFilters_Select();
 

StockManufacturers_SelectAll

Returns a list of manufacturers for a website.

Object Returned

List<ngage_StockManufacturers_SelectAllResult>
  • AddressCountryId (int)
  • AddressLineOne (string)
  • AddressLineTwo (string)
  • AddressStateId (int)
  • AssetTreeId (long)
  • BusinessName (string)
  • Id (long)
  • Postcode (string)
  • Town (string)

Code Example

List<ngage_StockManufacturers_SelectAllResult> item = Helper.Data.ngage_StockManufacturers_SelectAll();
 

StockRelatedItems

Returns a list related stock items for the passed in stock id.

Properties

  • StockId

Object Returned

List<ngage_StockRelatedItemsResult>
  • AliasUrl (string)
  • Description (string)
  • DisplayImageGallery (bool)
  • FileName (string)
  • Id (long)
  • IsActive (bool)
  • StockNo (string)
  • Title (string)

Code Example

List<ngage_StockRelatedItemsResult> item = Helper.Data.ngage_StockRelatedItems('stockId');
 

StockSize_ById

Returns a list of variation two items for the passed in variation two id.

Properties

  • SizeId

Object Returned

ngage_StockSize_ByIdResult
  • AllowedToPurchase (bool)
  • BinLocation (string)
  • ColourId (long)
  • ColourName (string)
  • Id (long)
  • OrderQtyLimit (int)
  • SiteId (long)
  • Size (string)
  • SizeId (long)
  • SizeName (string)
  • StockAllocated (int)
  • StockId (long)
  • StockLevel (int)
  • StockLevelAction (string)
  • StockLevelErrorMessage (string)
  • Title (string)
  • VatExclusive (bool)
  • Weight (long)

Code Example

ngage_StockSize_ByIdResult item = Helper.Data.ngage_StockSize_ById('sizeId');
 

StockSizes_ByColourId

Returns a list of variation two items for the passed in variation one id.

Properties

  • ColourId

Object Returned

List<ngage_StockSizes_ByColourIdResult>
  • AllowedToPurchase (bool)
  • BarCode (string)
  • ColourId (long)
  • DateModified (datetime)
  • Id (long)
  • Ordinal (int)
  • Size (string)
  • StockId (long)
  • StockLevel (int)
  • StockLevelErrorMessage (string)
  • VatExclusive (bool)
  • Weight (long)

Code Example

List<ngage_StockSizes_ByColourIdResult> item = Helper.Data.ngage_StockSizes_ByColourId('colourId');
 

StockSizes_ByStockId

Returns a list of variation two items for the passed in stock id.

Properties

  • StockId

Object Returned

List<ngage_StockSizes_ByStockIdResult>
  • AllowedToPurchase (bool)
  • BarCode (string)
  • ColourId (long)
  • DateModified (datetime)
  • Id (long)
  • Ordinal (int)
  • Size (string)
  • StockId (long)
  • StockLevel (int)
  • StockLevelErrorMessage (string)
  • VatExclusive (bool)
  • Weight (long)

Code Example

List<ngage_StockSizes_ByStockIdResult> item = Helper.Data.ngage_StockSizes_ByStockId('stockId');
 

TagGroups_SelectAll

Returns a list of content tagging groups.

Object Returned

List<ngage_TagGroups_SelectAllResult>
  • ParentId (long)
  • Title (string)
  • TreeId (long)

Code Example

List<ngage_TagGroups_SelectAllResult> item = Helper.Data.ngage_TagGroups_SelectAll();
 

Tags_SelectByParentId

Returns a list of content tagging groups for the parent tree id.

Properties

  • ParentTreeId

Object Returned

List<ngage_Tags_SelectByParentIdResult>
  • ParentId (long)
  • ParentName (string)
  • Title (string)
  • TreeId (long)

Code Example

List<ngage_Tags_SelectByParentIdResult> item = Helper.Data.ngage_Tags_SelectByParentId('parentTreeId');
 

TimeZones_SelectBySiteId

Returns a list of time zones assigned to a particular website.

Object Returned

List<ngage_TimeZones_SelectBySiteIdResult>
  • ISO3166 (string): ISO country code
  • Id (int): Database Id
  • TimeZone (string): Timezone (GMT Standard Time)
  • TimeZoneCountry (string): Display country name
  • TimeZonePhoneCode (string): 2 digit phone code for the country

Code Example

List<ngage_TimeZones_SelectBySiteIdResult> timezones = Helper.Data.ngage_TimeZones_SelectBySiteId().ToList();
 

Tree_CheckModified

Returns a date the last time a tree item was changed, used for caching data.

Properties

  • Id

Object Returned

ngage_Tree_CheckModifiedResult
  • DateModified (datetime)

Code Example

ngage_Tree_CheckModifiedResult item = Helper.Data.ngage_Tree_CheckModified('id');
 

Tree_ProcessArchived

INTERNAL USE ONLY, used in the ngage windows service, to process any data waiting to be archived.

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_Tree_ProcessArchived();
 

Tree_Select

Returns all tree items.

Properties

  • OrderBy

Object Returned

List<ngage_Tree_SelectResult>
  • ChildModified (datetime)
  • CmsTemplateId (long)
  • ContextMenu (string)
  • DateModified (datetime)
  • GroupReadPermissions (string)
  • HelpTopicId (long)
  • Id (long)
  • IsActive (bool)
  • IsFolder (bool)
  • IsNavigation (string)
  • IsPermissible (bool)
  • IsSystemFolder (bool)
  • LastEditBy (string)
  • ParentId (long)
  • SmallIcon (string)
  • Title (string)
  • ToolTip (string)
  • TreeObjectType (string)
  • rownum (long)

Code Example

List<ngage_Tree_SelectResult> item = Helper.Data.ngage_Tree_Select('orderBy');
 

Tree_Select_ByUserGroupParentId

Returns a list of tree items for a cms user with read permissions.

Properties

  • UserGroupId
  • ParentId
  • SearchTerm
  • SelectedTreeId
  • OrderBy
  • OrderByDirection
  • FoldersOnly
  • PageSize
  • CurrentPage
  • IsPermissionTree

Object Returned

List<ngage_Tree_Select_ByUserGroupParentIdResult>
  • CmsTemplateId (long)
  • ContextMenu (string)
  • DateModified (datetime)
  • HasChildren (bool)
  • HelpTopicId (long)
  • Id (long)
  • IsFolder (bool)
  • IsOpen (bool)
  • IsSystemFolder (bool)
  • LargeIcon (string)
  • ParentId (long)
  • ReadPermission (bool)
  • SmallIcon (string)
  • Title (string)
  • ToolTip (string)
  • WritePermission (bool)

Code Example

List<ngage_Tree_Select_ByUserGroupParentIdResult> item = Helper.Data.ngage_Tree_Select_ByUserGroupParentId('userGroupId','parentId','searchTerm','selectedTreeId','orderBy','orderByDirection','foldersOnly','pageSize','currentPage','isPermissionTree');
 

Tree_Select_ParentIds

Returns a string of parent Tree Ids for the tree id passed in.

Properties

  • TreeId: The tree id of the parents returned.

Object Returned

ngage_Tree_Select_ParentIdsResult
  • ParentIdList (string): A spaced list of Tree Ids

Code Example

ngage_Tree_Select_ParentIdsResult treeInfo = Helper.Data.ngage_Tree_Select_ParentIds(200);
 

Tree_SelectById

Returns a tree item for the passed in tree id.

Properties

  • TreeId

Object Returned

List<ngage_Tree_SelectByIdResult>
  • CmsTemplateId (long)
  • ContextMenu (string)
  • CreatedBy (string)
  • DateCreated (datetime)
  • DateModified (datetime)
  • HelpTopicId (long)
  • Id (long)
  • IsFolder (bool)
  • IsPermissible (bool)
  • IsSystemFolder (bool)
  • LargeIcon (string)
  • LastEditBy (string)
  • LastEditedDate (datetime)
  • ParentId (long)
  • SmallIcon (string)
  • Title (string)
  • ToolTip (string)
  • TreeObjectType (string)

Code Example

List<ngage_Tree_SelectByIdResult> item = Helper.Data.ngage_Tree_SelectById('treeId');
 

Tree_SelectChildren_ByTreeId

Returns a list of tree items for the passed in parent id.

Properties

  • ParentId
  • IsRecursive

Object Returned

List<ngage_Tree_SelectChildren_ByTreeIdResult>
  • CmsTemplateId (long)
  • ContextMenu (string)
  • DateModified (datetime)
  • HelpTopicId (long)
  • Id (long)
  • IsFolder (bool)
  • IsSystemFolder (bool)
  • LargeIcon (string)
  • ParentId (long)
  • SmallIcon (string)
  • Title (string)
  • ToolTip (string)

Code Example

List<ngage_Tree_SelectChildren_ByTreeIdResult> item = Helper.Data.ngage_Tree_SelectChildren_ByTreeId('parentId','isRecursive');
 

Tree_SelectCrumbs_ByTreeId

Returns a string of display titles for the passed in tree id.

Properties

  • TreeId

Object Returned

ngage_Tree_SelectCrumbs_ByTreeIdResult
  • CrumbString (string)

Code Example

ngage_Tree_SelectCrumbs_ByTreeIdResult item = Helper.Data.ngage_Tree_SelectCrumbs_ByTreeId('treeId');
 

TreeIsMembersOnly

Returns a Boolean to check if a particular tree item is marked as members only.

Properties

  • TreeId: The id of the tree item to check.

Object Returned

ngage_TreeIsMembersOnlyResult
  • IsMembersOnly (bool): If true the item is members only

Code Example

ngage_TreeIsMembersOnlyResult treeItem = Helper.Data.ngage_TreeIsMembersOnly(200);
 

UrlAlias_Select_Url

Returns an object which is associated with a URL.

Properties

  • Url: The URL of the current request.
  • IsMvcSite: If true the return URL will be a MVC controller (use Helper.Settings.IsMvcSite).

Object Returned

ngage_TreeIsMembersOnlyResult
  • TreeId (long): The Tree Id of the item returned
  • IsPrimaryAlias (bool): If false then a redirect should occur to the PrimaryUrlAlias (stops duplicate search engine issues)
  • PrimaryUrlAlias (string): The URL to redirect if IsPrimaryAlias = false
  • DateModified (datetime): The last date this item was modified (usually when a tree item has been renamed)
  • MvcUrl (string): The URL for MVC controller (only returned if your website is running in Helper.Settings.IsMvcSite mode)
  • FileLocation (string): The actual aspx file location (used in the URL aliasing re-writing module)

Code Example

ngage_UrlAlias_Select_UrlResult item = Helper.Data.ngage_UrlAlias_Select_Url("/home/", Helper.Settings.IsMvcSite);
 

UrlRedirect_SelectAll

Returns a list of all custom redirects added within the settings area of the CMS.

Object Returned

List<ngage_UrlRedirect_SelectAllResult>
  • Id (long): The Database Id of the item
  • Url (string): The URL to redirect from
  • RedirectUrl (string): The URL to redirect to
  • StatusCode (string): The status code to apply when redirecting
  • SiteId (long): The website Database Id

Code Example

List<ngage_UrlRedirect_SelectAllResult> items = Helper.Data.ngage_UrlRedirect_SelectAll();
 

UserAddresses_Delete

Deletes a web users address record.

Properties

  • Id

Object Returned

ngage_UserAddresses_DeleteResult
  • result (string)

Code Example

ngage_UserAddresses_DeleteResult item = Helper.Data.ngage_UserAddresses_Delete('id');
 

UserAddresses_ForeignInsert

Updates/inserts a web users address from a foreign source, example (CRM or ebay/amazon).

Properties

  • UserId
  • FirstName
  • Surname
  • BusinessName
  • AddressLineOne
  • AddressLineTwo
  • Town
  • StateName
  • CountryCode
  • Postcode

Object Returned

ngage_UserAddresses_ForeignInsertResult
  • Result (string)

Code Example

ngage_UserAddresses_ForeignInsertResult item = Helper.Data.ngage_UserAddresses_ForeignInsert('userId','firstName','surname','businessName','addressLineOne','addressLineTwo','town','stateName','countryCode','postcode');
 

UserAddresses_Insert

Inserts a address record for a web user.

Properties

  • UserId
  • FirstName
  • Surname
  • BusinessName
  • AddressLineOne
  • AddressLineTwo
  • Town
  • StateId
  • CountryId
  • Postcode
  • IsPrimaryBilling
  • IsPrimaryShipping

Object Returned

ngage_UserAddresses_InsertResult
  • AddressLineOne (string)
  • AddressLineTwo (string)
  • BusinessName (string)
  • CountryCode (string)
  • CountryCodeId (int)
  • CountryName (string)
  • FirstName (string)
  • Id (long)
  • Postcode (string)
  • StateAbbrev (string)
  • StateName (string)
  • Surname (string)
  • Town (string)
  • UserId (long)

Code Example

ngage_UserAddresses_InsertResult item = Helper.Data.ngage_UserAddresses_Insert('userId','firstName','surname','businessName','addressLineOne','addressLineTwo','town','stateId','countryId','postcode','isPrimaryBilling','isPrimaryShipping');
 

UserAddresses_Select_ById

Returns a web users address.

Properties

  • Id

Object Returned

ngage_UserAddresses_Select_ByIdResult
  • AddressLineOne (string)
  • AddressLineTwo (string)
  • BusinessName (string)
  • CountryCode (string)
  • CountryCodeId (int)
  • CountryName (string)
  • FirstName (string)
  • Id (long)
  • Postcode (string)
  • StateAbbrev (string)
  • StateName (string)
  • Surname (string)
  • Town (string)
  • UserId (long)

Code Example

ngage_UserAddresses_Select_ByIdResult item = Helper.Data.ngage_UserAddresses_Select_ById('id');
 

UserAddresses_Select_ByUserId

Returns a list of address information for a web user.

Properties

  • UserId

Object Returned

List<ngage_UserAddresses_Select_ByUserIdResult>
  • AddressLineOne (string)
  • AddressLineTwo (string)
  • AddressLongDescription (string)
  • BusinessName (string)
  • CountryCode (string)
  • CountryId (int)
  • CountryName (string)
  • FirstName (string)
  • Id (long)
  • IsPrimaryBilling (bool)
  • IsPrimaryShipping (bool)
  • Postcode (string)
  • StateAbbrev (string)
  • StateId (int)
  • StateName (string)
  • Surname (string)
  • Town (string)
  • UserId (long)

Code Example

List<ngage_UserAddresses_Select_ByUserIdResult> item = Helper.Data.ngage_UserAddresses_Select_ByUserId('userId');
 

UserAddresses_Update

Updates/inserts a users address record.

Properties

  • AddressId
  • FirstName
  • Surname
  • BussinessName
  • AddressLineOne
  • AddressLineTwo
  • Town
  • Postcode
  • AddressCountryId
  • StateId
  • IsPrimaryBilling
  • IsPrimaryShipping

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_UserAddresses_Update('addressId','firstName','surname','bussinessName','addressLineOne','addressLineTwo','town','postcode','addressCountryId','stateId','isPrimaryBilling','isPrimaryShipping');
 

UserAssignedItemReceipt_Insert

Upates an assigned item, validates that a web user has acknowledged receipt of content/asset/link.

Properties

  • UserId
  • UserAssignedItemId

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_UserAssignedItemReceipt_Insert('userId','userAssignedItemId');
 

UserAssignedLinks_Delete

Deletes the link between a asset/content/link and a web user.

Properties

  • LinkType
  • UserAssignedLinksId

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_UserAssignedLinks_Delete('linkType','userAssignedLinksId');
 

UserAssignedLinks_Insert

Assigns an asset/content/link to a web user.

Properties

  • LinkType
  • UserId
  • Title
  • FileExt
  • OriginalFileName
  • FileName
  • FolderLocation
  • Group

Object Returned

ngage_UserAssignedLinks_InsertResult
  • NewUserAssignedLinkId (long)

Code Example

ngage_UserAssignedLinks_InsertResult item = Helper.Data.ngage_UserAssignedLinks_Insert('linkType','userId','title','fileExt','originalFileName','fileName','folderLocation','group');
 

UserAssignedLinks_Select

Returns a list of assets/content/links assigned to a web user.

Properties

  • UserId
  • UploadType
  • DisplayType

Object Returned

List<ngage_UserAssignedLinks_SelectResult>
  • Content (string)
  • ContentType (string)
  • DateCreated (datetime)
  • FileExt (string)
  • Group (string)
  • Id (long)
  • ReceiptText (string)
  • Title (string)
  • UserAssignedLinkId (long)

Code Example

List<ngage_UserAssignedLinks_SelectResult> item = Helper.Data.ngage_UserAssignedLinks_Select('userId','uploadType','displayType');
 

UserAssignedLinks_SelectAsset

Returns a single asset assigned to a web user.

Properties

  • UserId
  • UploadType
  • DisplayType
  • AssetId

Object Returned

ngage_UserAssignedLinks_SelectAssetResult
  • Content (string)
  • ContentType (string)
  • FileExt (string)
  • FileName (string)
  • FilePath (string)
  • Id (long)
  • OriginalFileName (string)
  • Title (string)

Code Example

ngage_UserAssignedLinks_SelectAssetResult item = Helper.Data.ngage_UserAssignedLinks_SelectAsset('userId','uploadType','displayType','assetId');
 

UserInsert

Inserts a website user.

Properties

  • Username
  • Pass
  • Title
  • Firstname
  • Surname
  • Organisation
  • Email
  • Mobile
  • Phone
  • ForeignId
  • UserTypeIds
  • Sex
  • Dob
  • TimeZoneId
  • ExtraInfoFieldOne
  • ExtraInfoFieldTwo

Object Returned

ngage_UserInsertResult
  • NewUserId (long)

Code Example

ngage_UserInsertResult item = Helper.Data.ngage_UserInsert('username','pass','title','firstname','surname','organisation','email','mobile','phone','foreignId','userTypeIds','sex','dob','timeZoneId','extraInfoFieldOne','extraInfoFieldTwo');
 

UserLogin

Returns the id of the user and the result of the login (invalid password etc).

Properties

  • Username: The username provided by the user at login.
  • Password: The password provided by the user at login, this needs to be encrypted using WebUser.Encrypt().
  • UserTypeIds: A comma deliminated string of ids, websites can have different groups of users, the default is '2' (website users).

Object Returned

ngage_UserLoginResult
  • Id (long): The Database Id of the user
  • Result (string): The login result, a valid login result will be 'OK'

Code Example

ngage_UserLogin item = Helper.Data.ngage_UserLogin('username', 'password-hash', '2');
 

UserLoginResult

Returns the id of the user and the result of the login (invalid password etc).

Properties

  • Username: The username provided by the user at login.
  • Password: The password provided by the user at login, this needs to be encrypted using WebUser.Encrypt().
  • UserTypeIds: A comma deliminated string of ids, websites can have different groups of users, the default is '2' (website users).

Object Returned

ngage_UserLogin
  • Id (long): The Database Id of the user
  • Result (string): The login result, a valid login result will be 'OK'

Code Example

ngage_UserLogin item = Helper.Data.ngage_UserLogin('username', 'password-hash', '2');
 

Users_Approve

Marks the web user as approved and returns users data (allows the user to login to assigned website User Types).

Properties

  • UserId: The users email address.

Object Returned

ngage_Users_ApproveResult
  • Id (long): The Database Id of the item
  • Username (string): Login username
  • Title (string): Users Saluation
  • Firstname (string): Users first name
  • Surname (string): Users surname
  • Organisation (string): Users organisation
  • Email (string): Users email address
  • Phone (string): Users phone number
  • Mobile (string): Users mobile number
  • OrderInvoiceAllowed (string): User has the option of invoicing at checkout (payment can be bypassed)
  • OrderPromoCode (string): Users discount, which is automatically applied at checkout
  • ExtraInfoFieldOne (string): Custom field for extrenal storage
  • ExtraInfoFieldTwo (string): Custom field for extrenal storage
  • UserTypeId (long): The group type which the user is asssigned to (example 'Web Users' etc)

Code Example

ngage_Users_ApproveResult item = Helper.Data.ngage_Users_Approve('userId');
 

Users_CheckForUser

Returns a string result if a users email or username already exists.

Properties

  • Email: The users email address.
  • Username: The users login username.

Object Returned

ngage_Users_CheckForUserResult
  • Result (string): The return result, 'OK' will be returned if a user is not found ('OK', 'Email Address', 'Username', 'Account Expired')

Code Example

ngage_Users_CheckForUser item = Helper.Data.ngage_Users_CheckForUser('email', 'username');
 

Users_Delete

Deletes a user from the system.

Properties

  • UserId: The Database Id of the user to delete.

Object Returned

bool

Code Example

bool isDeleted = Helper.Data.ngage_Users_Delete('userId');
 

Users_SelectAllWeb

Returns a list of all website users with billing and shipping address information, duplicates users will be found for users with multiple addresses.

Properties

  • DateReceived: If your application is storing a list of webiste users, you can retreive any newly added users by passing in the max DateCreated from the stored users list, to receive a full list enter DateTime.Min.

Object Returned

List<ngage_Users_SelectAllWeb>
  • Id (long): The Database Id of the item
  • Username (string): Login username
  • Title (string): Saluation title
  • Firstname (string): Users first name
  • Surname (string): Users surname
  • Organisation (string): Users organisation
  • Email (string): Users email address
  • Phone (string): Users phone number
  • Mobile (string): Users mobile number
  • ExtraInfoFieldOne (string): Custom field for extrenal storage
  • ExtraInfoFieldTwo (string): Custom field for extrenal storage
  • UserTypeId (long): The group type which the user is asssigned to (example 'Web Users' etc)
  • IsActive (bool): Marked as true if the user has a valid active account
  • AddressId (long): The Database Id of the users prefered address
  • BusinessName (string): Address business name
  • AddressLineOne (string): Address line one
  • AddressLineTwo (string): Address line two
  • Town (string): Address town
  • Postcode (string): Address postcode
  • AddressStateId (long): The Database Id for the state
  • AddressCountryId (long): The Database Id for the country
  • StateName (string): State name
  • CountryName (string): Country name

Code Example

List<ngage_Users_SelectAllWeb> items = Helper.Data.ngage_Users_SelectAllWeb('2012-01-01').ToList();
 

Users_SelectByEmail

Returns a user for the matching email address.

Properties

  • Email: The users email address.

Object Returned

ngage_Users_SelectByEmailResult
  • Firstname (string): Users first name
  • Surname (string): Users surname
  • Email (string): Users email address
  • Phone (string): Users phone number
  • Mobile (string): Users mobile number

Code Example

ngage_Users_SelectByEmailResult item = Helper.Data.ngage_Users_SelectByEmail('email');
 

Users_SelectByEmailUsername

Returns a user for the matching email address and username, if no user is found the email is set to 'NotFound', if the user is found but inactive the email is set to 'InActive'.

Properties

  • Email: The users email address.
  • Username: The users login username.

Object Returned

ngage_Users_SelectByEmailUsernameResult
  • Firstname (string): Users first name
  • Surname (string): Users surname
  • Email (string): Users email address
  • Phone (string): Users phone number
  • Mobile (string): Users mobile number

Code Example

ngage_Users_SelectByEmailUsernameResult item = Helper.Data.ngage_Users_SelectByEmailUsername('email', 'username');
 

Users_SelectByForeignId

Selects a web user by the forgeign id, generally used for CRM integration.

Properties

  • ForeignId

Object Returned

ngage_Users_SelectByForeignIdResult
  • Email (string)
  • Firstname (string)
  • Id (long)
  • Mobile (string)
  • Surname (string)
  • Username (string)

Code Example

ngage_Users_SelectByForeignIdResult item = Helper.Data.ngage_Users_SelectByForeignId('foreignId');
 

Users_SelectById

Returns a user for the matching Database Id, if no user is found the email is set to 'NotFound', if the user is found but inactive the email is set to 'InActive'.

Properties

  • Id: The users Database Id.

Object Returned

ngage_Users_SelectByIdResult
  • Id (long): The Database Id of the item
  • Username (string): Login username
  • Title (string): Users Saluation
  • Firstname (string): Users first name
  • Surname (string): Users surname
  • Organisation (string): Users organisation
  • Email (string): Users email address
  • Phone (string): Users phone number
  • Mobile (string): Users mobile number
  • OrderInvoiceAllowed (string): User has the option of invoicing at checkout (payment can be by-passed)
  • OrderPromoCode (string): Users discount, which is automatically applied at checkout
  • ExtraInfoFieldOne (string): Custom field for extrenal storage
  • ExtraInfoFieldTwo (string): Custom field for extrenal storage
  • UserTypeId (long): The group type which the user is asssigned to (example 'Web Users' etc)
  • EmailSignature (string): Users email signature (generally used for advanced custom account areas)
  • Dob (string): Users date of birth (generally used for advanced custom account areas)
  • Sex (string): Users sex (example: 'Male/Female', generally used for advanced custom account areas)
  • LastLoggedIn (string): The datetime the user last logged in
  • TimeZone (string): Users timezone (example: 'GMT Standard Time')
  • TimeZoneCountry (string): Users timezone country (example: 'United Kingdom')
  • TimeZoneId (string): Users timezone Database Id
  • TimeZonePhoneCode (string): Users timezone phone prefix (example: '44')

Code Example

ngage_Users_SelectByIdResult item = Helper.Data.ngage_Users_SelectById('id');
 

Users_Update

Updates a web users record.

Properties

  • UserId
  • Firstname
  • Surname
  • EmailAddress
  • Username
  • Mobile
  • ExtraInfoFieldOne
  • ExtraInfoFieldTwo
  • Title
  • Organisation
  • Phone
  • Sex
  • Dob
  • UserTypeIdList
  • ExpiryDate

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_Users_Update('userId','firstname','surname','emailAddress','username','mobile','extraInfoFieldOne','extraInfoFieldTwo','title','organisation','phone','sex','dob','userTypeIdList','expiryDate');
 

Users_UpdateCurrentPassword

Should not be used, internal use only, see 'WebUser.UpdatePassword' method.

Properties

  • UserId
  • NewPassword
  • OldPassword

Object Returned

bool

Code Example

bool item = Helper.Data.ngage_Users_UpdateCurrentPassword('userId','newPassword','oldPassword');
 

Users_UpdatePassword

Should not be used, internal use only, see 'WebUser.UpdatePassword' method.

Properties

  • Guid
  • NewPassword

Object Returned

ngage_Users_UpdatePasswordResult
  • UserId (long)

Code Example

ngage_Users_UpdatePasswordResult item = Helper.Data.ngage_Users_UpdatePassword('guid','newPassword');
 

Users_ValidPasswordGuid

Should not be used, internal use only, see 'WebUser.UpdatePassword' method.

Properties

  • Guid

Object Returned

ngage_Users_ValidPasswordGuidResult
  • Id (long)

Code Example

ngage_Users_ValidPasswordGuidResult item = Helper.Data.ngage_Users_ValidPasswordGuid('guid');
 

UserTitle_SelectAll

Returns a list of user titles (example Mr, Miss).

Object Returned

List<ngage_UserTitle_SelectAllResult>
  • Id (long): The Database Id of the item
  • Title (string): The display title (example Mr, Miss etc)

Code Example

List<ngage_UserTitle_SelectAll> items = Helper.Data.ngage_UserTitle_SelectAll();
 

UserTypeCodeValidate

Validates a promotional code assigned to a web user.

Properties

  • UserId
  • PromoCode

Object Returned

ngage_UserTypeCodeValidateResult
  • IsValid (bool)

Code Example

ngage_UserTypeCodeValidateResult item = Helper.Data.ngage_UserTypeCodeValidate('userId','promoCode');
 

Add Feedback