LCE.GatewayPortal.PortalAPI Help Page

Introduction

Provides a list of APIs to serve data to Gateway Portal Web Application only.

Image

API	Description
POST GatewayPortalAPI/api/Image	No documentation available.
POST api/Image/GetArticleImage()	No documentation available.

ContentAppAPI

API	Description
POST GatewayPortalAPI/api/ContentAppAPI	No documentation available.
POST GetContentNewsArticles	No documentation available.
POST GetWidgetContentNewsArticles	No documentation available.
POST GetArticleContent	No documentation available.
POST GetEventCalendarArticles	No documentation available.
POST SetEventCalendar	No documentation available.
GET GetAnnouncements?userName={userName}&language={language}	No documentation available.
POST api/ContentAppAPI/Announcements	No documentation available.
POST Acknowledge	No documentation available.
GET GetAcknowledgedArticles?userName={userName}&language={language}	No documentation available.
POST GetViews	No documentation available.
GET GetArticlesCount?userName={userName}&listName={listName}	No documentation available.
POST GetContentReportBlobs?userName={userName}	No documentation available.
POST api/ContentAppAPI/GetWidgetContentArticles	No documentation available.

VOGUserManagement

API	Description
POST GatewayPortalAPI/api/VOGUserManagement	No documentation available.
GET api/VOGUserManagement/GetVOGUsers?email={email}&franNum={franNum}	No documentation available.
GET api/VOGUserManagement/CheckVOGUser?userId={userId}	No documentation available.
GET api/VOGUserManagement/UserExists?email={email}	No documentation available.
POST api/VOGUserManagement/CreateQualtricsUser	No documentation available.
POST api/VOGUserManagement/UpdateUserAndImport	No documentation available.
POST api/VOGUserManagement/DeleteUser	No documentation available.
POST api/VOGUserManagement/HandleException	No documentation available.

UserPasswordChageLog

API	Description
POST GatewayPortalAPI/api/UserPasswordChageLog	No documentation available.
POST api/UserPasswordChangeLog/PostUserPasswordChangeLog	No documentation available.
POST api/UserPasswordChageLog/HandleException	No documentation available.

GatewaySSO

API	Description
POST GatewayPortalAPI/api/GatewaySSO	No documentation available.
GET GetToken?userName={userName}&appName={appName}&userId={userId}	No documentation available.
POST ProfitKeeperSignOnToken	No documentation available.
POST FranConnectSignOnToken	No documentation available.
POST api/GatewaySSO/HandleException	No documentation available.

Authorization

API	Description
POST GatewayPortalAPI/api/Authorization	No documentation available.
GET GetUserRoles?userName={userName}	No documentation available.
GET InsertUserRole?userName={userName}&userRole={userRole}	No documentation available.
GET InsertUserLanguage?userName={userName}&userLanguage={userLanguage}	No documentation available.
POST api/Authorization/HandleException	No documentation available.

Search

API	Description
GET GatewayPortalAPI/api/Search	No documentation available.
POST ArticleSearch	No documentation available.
POST APPSearch	No documentation available.
POST ContactsSearch	No documentation available.
POST CommonResourceSearch	No documentation available.
POST SearchView	No documentation available.
GET api/Search/GetResourceTypeIcons	No documentation available.

UserLogException

API	Description
POST GatewayPortalAPI/api/UserLogException	No documentation available.
GET api/UserLogException/GetUserLogExceptions?searchUserName={searchUserName}	No documentation available.
GET api/UserLogException/GetUserLastSuccessfulLogin?searchUserName={searchUserName}	No documentation available.
POST api/UserLogException/PostUserLogException	No documentation available.
POST api/UserLogException/HandleException	No documentation available.

WidgetAPI

API	Description
POST GatewayPortalAPI/api/WidgetAPI	No documentation available.
GET GetGatewayWidgets?userName={userName}	No documentation available.
GET GetDefaultObjects?userName={userName}	No documentation available.
POST SetCustomizedWidgets	No documentation available.
GET GetPersonalizedtObjectWidgets?userName={userName}	No documentation available.
POST api/WidgetAPI/HandleException	No documentation available.

CVCloudUserProfile

API	Description
POST GatewayPortalAPI/api/CVCloudUserProfile	No documentation available.
GET api/CVCloudUserProfile/GetOktaAvailableUserName?firstName={firstName}&lastName={lastName}	No documentation available.
GET api/CVCloudUserProfile/IsOktaUserNameAvailable?Login={Login}	No documentation available.
POST api/CVCloudUserProfile/AddUserDevice	No documentation available.
GET api/CVCloudUserProfile/GetUserDevices?UserName={UserName}&UserCanAccessDeviceInformation={UserCanAccessDeviceInformation}&IsUserHasGatewayHelpDeskRole={IsUserHasGatewayHelpDeskRole}&FranNum={FranNum}&StoreNum={StoreNum}	No documentation available.
POST api/CVCloudUserProfile/UpdateUserDevice	No documentation available.
POST api/CVCloudUserProfile/HandleException	No documentation available.

ApplicationsAPI

API	Description
POST GatewayPortalAPI/api/ApplicationsAPI	No documentation available.
GET GetHomePageApplications?userName={userName}	No documentation available.
GET GetHomePageHelpfulLinks?userName={userName}	No documentation available.
POST AppShareViaEmail	No documentation available.
POST GetUserCustomizedApps	No documentation available.
GET GetUserTermsAndPolicyAcceptance?userName={userName}	No documentation available.
GET SetUserTermsandPolicyAcceptance?userName={userName}&policyId={policyId}	No documentation available.
POST api/ApplicationsAPI/HandleException	No documentation available.

ContentMetricTrack

API	Description
POST GatewayPortalAPI/api/ContentMetricTrack	No documentation available.
POST api/ContentMetricTrack/PostTrackUserAccessedContent	No documentation available.
GET api/ContentMetricTrack/GetTrackUserAccessedContent?NumberOfDays={NumberOfDays}	No documentation available.
POST api/ContentMetricTrack/HandleException	No documentation available.

Video

API	Description
POST GatewayPortalAPI/api/Video	No documentation available.
POST api/Video/GetArticleVideo()	No documentation available.

AdminAPI

API	Description
POST GatewayPortalAPI/api/AdminAPI	No documentation available.
GET GetListOfUsers?userName={userName}	No documentation available.
POST api/AdminAPI/HandleException	No documentation available.

MyBusinessProfileAPI

API	Description
POST GatewayPortalAPI/api/MyBusinessProfileAPI	No documentation available.
GET GetAllBusinessInformation?userId={userId}&userName={userName}&menuControl={menuControl}&officeId={officeId}	No documentation available.
GET GetAddress?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET GetContact?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET GetKeyContact?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET GetShareHolder?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET GetOffice?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
POST AddKeyContact	No documentation available.
POST UpdateKeyContact	No documentation available.
POST UpdateAddress	No documentation available.
POST UpdateShareHolder	No documentation available.
GET GetFranchise?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET GetEmailTypes?userId={userId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET DeleteKeyContact?franchiseeKeyContactId={franchiseeKeyContactId}&userName={userName}&menuControl={menuControl}	No documentation available.
GET GetStatesList?userName={userName}&countryId={countryId}	No documentation available.
GET CountryCode?userName={userName}&countryId={countryId}	No documentation available.
POST api/MyBusinessProfileAPI/HandleException	No documentation available.

RedemptionCode

API	Description
POST GatewayPortalAPI/api/RedemptionCode	No documentation available.
GET GetRedemptionCodes?UserName={UserName}	No documentation available.
POST SetRedemptionCode	No documentation available.
POST SendEmail	No documentation available.
POST SendSMS	No documentation available.
POST api/RedemptionCode/HandleException	No documentation available.

CSS

API	Description
POST GatewayPortalAPI/api/CSS	No documentation available.
POST api/CSS/GetCSS()	No documentation available.

ForgotPassword

API	Description
GET api/ForgotPassword/SendPasswordReset?UserName={UserName}	No documentation available.
GET api/ForgotPassword/ValidateToken?Token={Token}	No documentation available.
POST api/ForgotPassword/PasswordUpdate	No documentation available.

Calendar

API	Description
POST api/Calendar/Index	No documentation available.
POST api/Calendar/Items	No documentation available.

UserProfileInformation

API	Description
GET api/UserProfileInformation/GetPersonalProfileInfo?userName={userName}&userId={userId}&menuName={menuName}	No documentation available.
GET api/UserProfileInformation/GetUserEmailForProfileImage?userName={userName}	No documentation available.
GET api/UserProfileInformation/GetUserSubscriptionInfo?userName={userName}&userId={userId}	No documentation available.
GET api/UserProfileInformation/GetLceAccessToken?userName={userName}	No documentation available.
POST api/UserProfileInformation/UserProfile	No documentation available.
GET api/UserProfileInformation/UserFirstLogIn?userName={userName}&userId={userId}	No documentation available.
GET api/UserProfileInformation/GetTeamInfo?userName={userName}&franchiseeId={franchiseeId}&menuControl={menuControl}	No documentation available.
GET api/UserProfileInformation/GetUserTimeZone?userName={userName}	No documentation available.
GET api/UserProfileInformation/GetFranchiseInfo?userName={userName}&userId={userId}&menuControl={menuControl}	No documentation available.
GET api/UserProfileInformation/GetStoreInfo?userName={userName}&userId={userId}&franchiseeId={franchiseeId}&menuControl={menuControl}	No documentation available.
GET api/UserProfileInformation/GetFranchiseStoreLocationInfo?userName={userName}	No documentation available.
GET api/UserProfileInformation/ManageMyTeamPermissions?userName={userName}	No documentation available.
POST api/UserProfileInformation/PostUserInfo	No documentation available.
POST api/UserProfileInformation/UpdateUserInfo	No documentation available.
POST api/UserProfileInformation/DeleteUserInfo	No documentation available.
GET api/UserProfileInformation/GetUserProfileMenu?userName={userName}	No documentation available.
GET api/UserProfileInformation/EmailListofFranchiseUsers?userName={userName}	No documentation available.
GET api/UserProfileInformation/GetOrgHierarchyTree?FranchiseNum={FranchiseNum}	No documentation available.
GET api/UserProfileInformation/GetGroups	No documentation available.
GET api/UserProfileInformation/GetUserInfo?UserId={UserId}	No documentation available.
POST api/UserProfileInformation/ReportingPreferenceGet	No documentation available.
POST api/UserProfileInformation/ReportingPreferencePost	No documentation available.
POST api/UserProfileInformation/HandleException	No documentation available.

Article

API	Description
POST api/Article/Index	No documentation available.
POST api/Article/Details	No documentation available.
POST api/Article/New	No documentation available.

UserLogin

API	Description
POST api/UserLogin/Login	No documentation available.
POST api/UserLogin/UserJobLogin	No documentation available.
POST api/UserLogin/VerifyPasscode	No documentation available.
POST api/UserLogin/ResendPasscode	No documentation available.
POST api/UserLogin/CleanupUserSession	No documentation available.

GetAuthenticationType

API	Description
GET GetAuthenticationType/GetAuthenticationTypes?userName={userName}	No documentation available.

Dashboard

API	Description
POST api/Dashboard/Index	No documentation available.
POST api/Dashboard/Stats	No documentation available.

PushNotifications

API	Description
GET PushNotifications?userName={userName}&articleId={articleId}	No documentation available.
GET SummaryNotifications?userName={userName}&messageSendingType={messageSendingType}&messageTiming={messageTiming}	No documentation available.
GET CriticalAlertsEmailNotifications?userName={userName}&messageTiming={messageTiming}	No documentation available.
GET CriticalAlertsSMSNotifications?userName={userName}	No documentation available.

Resource

API	Description
POST api/Resource/Common	No documentation available.
POST api/Resource/Contact	No documentation available.
POST api/DeleteContact?contactId={contactId}	No documentation available.
POST api/Resource/Type	No documentation available.
POST GetResourceTypes	No documentation available.
POST GetResourceCategories	No documentation available.
POST GetResourceArticleContent	No documentation available.
POST GetResourceContactPages	No documentation available.

Document

API	Description
POST GetFolder	No documentation available.
POST api/Document/GetDocuments	No documentation available.
POST api/Document/GetDocumentBasedOnURL	No documentation available.
POST api/Document/GetDocumentBasedOnFileRef	No documentation available.
POST api/Document/GetDocumentInformationBasedOnURL	No documentation available.

ReportBlobsAPI

API	Description
GET GetReportBlobs?userName={userName}&fileName={fileName}&numberOfDaysToPull={numberOfDaysToPull}	No documentation available.

People

API	Description
POST api/People/GetArticleAuthorPicture	No documentation available.
POST api/People/GetContactPicture	No documentation available.