ASP.NET Web API Help Page

Introduction

Provide a general description of Web APIs

Firstly we have implemented Paging, which have two parameters page and pagesize which are passing as a querysting in api request. If request doesn't have paging then it set default paging as page=0 and pagesize=1000.

For Sorting, we have four querysting combinations "sort-asc", "sort-desc", "sort-ascending", "sort-descending" as resultant it will sort in ascending or descending manner. If sorting not applied in request then By default it will be in ascending manner.

For Filter, we have two filter conditions "AND" and "OR". We have implemented different filters with LessThan, GreaterThan, LessThanOrEqual, GreaterThanOrEqual, Equal, NotEqual, Contains, StartsWith, EndsWith etc.. with use of AND and OR Conditions in web api request. We have passing short forms in querystring i.e. LessThanOrEqual(le), GreaterThanOrEqual(ge), LessThan(l), GreaterThan(g), Contains(c), NotContains(nc) etc..

Token

API	Description
GET Login?userName={userName}&password={password}	No documentation available.
GET Token	No documentation available.
GET CreateToken	No documentation available.
GET Dispose	No documentation available.
GET VerifyUserToken	No documentation available.
GET UpdateToken	No documentation available.
POST Token/LoginByApiKey?userName={userName}&apiKey={apiKey}	No documentation available.
GET Token/GetClientIpAddressFromRequest	No documentation available.

CacheManagement

API	Description
GET CacheManagement/Sync	No documentation available.
GET CacheManagement/InitializeApplicationInMemoryCache	No documentation available.
GET CacheManagement/SystemMessageReaderClearCache/{id}	No documentation available.
GET CacheManagement/SystemSettingReaderClearCache	No documentation available.
GET CacheManagement/GetClientIpAddressFromRequest	No documentation available.

ContentManagement

API	Description
GET ContentManagement/RawGetItemForView/{id}?mapName={mapName}	No documentation available.
GET ContentManagement/RawGetItemForEdit/{id}?mapName={mapName}	No documentation available.
GET ContentManagement/RawGetItemTemplateForAddNew/{id}?mapName={mapName}	No documentation available.
POST ContentManagement/RawSaveItem	No documentation available.
POST ContentManagement/RawPublishItem	No documentation available.
POST ContentManagement/RawCancelItem	No documentation available.
POST ContentManagement/RawDeleteItem	No documentation available.
GET ContentManagement/GetClientIpAddressFromRequest	No documentation available.

Testimonial

API	Description
POST Testimonial/PostTestimonialData	No documentation available.
GET Testimonial/AllTestimonials	No documentation available.
GET Testimonial/IsApproved	No documentation available.
GET Testimonial/ShowForAll	No documentation available.
GET Testimonial/SubdivisionsResults	No documentation available.
GET Testimonial/Websites	No documentation available.
GET Testimonial/Tags	No documentation available.
GET Testimonial/YoutubeUrl	No documentation available.
GET Testimonial/GetClientIpAddressFromRequest	No documentation available.

Profile

API	Description
GET Profile/Websites	No documentation available.
GET Profile/AdminWebsitesByContentMapID	No documentation available.
GET Profile/AdminWebsitesByContentMapReferenceID	No documentation available.
GET Profile/GetWebsiteReferenceItems	No documentation available.
GET Profile/GetAdminWebsiteReferenceItemsByContentMapID	No documentation available.
GET Profile/GetAdminWebsiteReferenceItemsByContentMapReferenceID	No documentation available.
GET Profile/GetAssociatedWebsiteReferenceItems	No documentation available.
GET Profile/Companies	No documentation available.
GET Profile/GetMainNavMenuStructures	No documentation available.
GET Profile/GetMainNavMenuStructuresByWebsiteID	No documentation available.
GET Profile/GetMainNavMenuStructuresByWebsiteProfileID	No documentation available.
GET Profile/GetMainNavMenuStructuresByWebsiteExternalID	No documentation available.
GET Profile/GetMainNavMenuStructuresByWebsiteReferenceID	No documentation available.
GET Profile/WebsiteItem	No documentation available.
GET Profile/WebsiteItemByWebsiteID	No documentation available.
GET Profile/WebsiteItemByWebsiteProfileID	No documentation available.
GET Profile/WebsiteItemByWebsiteExternalID	No documentation available.
GET Profile/WebsiteItemByWebsiteReferenceID	No documentation available.
GET Profile/WebsiteReferenceItem	No documentation available.
GET Profile/WebsiteReferenceItemByWebsiteID	No documentation available.
GET Profile/WebsiteReferenceItemByWebsiteProfileID	No documentation available.
GET Profile/WebsiteReferenceItemByWebsiteExternalID	No documentation available.
GET Profile/WebsiteReferenceItemByWebsiteReferenceID	No documentation available.
GET Profile/CompanyItem	No documentation available.
GET Profile/CompanyItemByCompanyID	No documentation available.
GET Profile/CompanyItemByCompanyProfileID	No documentation available.
GET Profile/CompanyItemByCompanyExternalID	No documentation available.
GET Profile/CompanyItemByCompanyReferenceID	No documentation available.
GET Profile/GetMainNavMenuStructure	No documentation available.
GET Profile/GetMainNavMenuStructureByWebsiteID	No documentation available.
GET Profile/GetMainNavMenuStructureByWebsiteProfileID	No documentation available.
GET Profile/GetMainNavMenuStructureByWebsiteExternalID	No documentation available.
GET Profile/GetMainNavMenuStructureByWebsiteReferenceID	No documentation available.
GET Profile/GetClientIpAddressFromRequest	No documentation available.

CmsJApiResponse

API	Description
GET CmsJApiResponse/PublicCallToActions	No documentation available.
GET CmsJApiResponse/PublicCallToActionsByWebsiteID	No documentation available.
GET CmsJApiResponse/PublicCallToActionsByWebsiteProfileID	No documentation available.
GET CmsJApiResponse/PublicCallToActionsByWebsiteExternalID	No documentation available.
GET CmsJApiResponse/PublicCallToActionsByWebsiteReferenceID	No documentation available.
GET CmsJApiResponse/GenericSubPages	No documentation available.
GET CmsJApiResponse/GenericSubPagesByWebsiteID	No documentation available.
GET CmsJApiResponse/GenericSubPagesByWebsiteProfileID	No documentation available.
GET CmsJApiResponse/GenericSubPagesByWebsiteExternalID	No documentation available.
GET CmsJApiResponse/GenericSubPagesByWebsiteReferenceID	No documentation available.
GET CmsJApiResponse/PublicInteriorPages	No documentation available.
GET CmsJApiResponse/PublicInteriorPagesByWebsiteID	No documentation available.
GET CmsJApiResponse/PublicInteriorPagesByWebsiteProfileID	No documentation available.
GET CmsJApiResponse/PublicInteriorPagesByWebsiteExternalID	No documentation available.
GET CmsJApiResponse/PublicInteriorPagesByWebsiteReferenceID	No documentation available.
GET CmsJApiResponse/PublicCallToAction	No documentation available.
GET CmsJApiResponse/PublicCallToActionByWebsiteID	No documentation available.
GET CmsJApiResponse/PublicCallToActionByWebsiteProfileID	No documentation available.
GET CmsJApiResponse/PublicCallToActionByWebsiteExternalID	No documentation available.
GET CmsJApiResponse/PublicCallToActionByWebsiteReferenceID	No documentation available.
GET CmsJApiResponse/GenericSubPage	No documentation available.
GET CmsJApiResponse/GenericSubPageByWebsiteID	No documentation available.
GET CmsJApiResponse/GenericSubPageByWebsiteProfileID	No documentation available.
GET CmsJApiResponse/GenericSubPageByWebsiteExternalID	No documentation available.
GET CmsJApiResponse/GenericSubPageByWebsiteReferenceID	No documentation available.
GET CmsJApiResponse/PublicInteriorPage	No documentation available.
GET CmsJApiResponse/PublicInteriorPageByWebsiteID	No documentation available.
GET CmsJApiResponse/PublicInteriorPageByWebsiteProfileID	No documentation available.
GET CmsJApiResponse/PublicInteriorPageByWebsiteExternalID	No documentation available.
GET CmsJApiResponse/PublicInteriorPageByWebsiteReferenceID	No documentation available.
GET CmsJApiResponse/GetClientIpAddressFromRequest	No documentation available.

BaseGlobalApi

API	Description
GET BaseGlobalApi/AssociatedWebsites	No documentation available.
GET BaseGlobalApi/SiteMapXml	No documentation available.
GET BaseGlobalApi/GetSiteMapXmlReferenceItems	No documentation available.
GET BaseGlobalApi/RobotsTxt	No documentation available.
GET BaseGlobalApi/GetRobotsTxtReferenceItems	No documentation available.
POST BaseGlobalApi/CreateNewNonce	No documentation available.
POST BaseGlobalApi/CreateNewNonceWithExpiration	No documentation available.
POST BaseGlobalApi/HasNonce	No documentation available.
POST BaseGlobalApi/HasNonceWithExistedClaimIDAndExpirationDateTime	No documentation available.
POST BaseGlobalApi/HasClaimNonce	No documentation available.
GET BaseGlobalApi/GetClientIpAddressFromRequest	No documentation available.

Webhook

API	Description
POST Webhook/DocuSign	No documentation available.
POST Webhook/ZohoSign	No documentation available.
POST Webhook/BizBuySell	No documentation available.
POST Webhook/BusinessBroker	No documentation available.
POST Webhook/DealStream	No documentation available.
POST Webhook/BusinessesForSale	No documentation available.
POST Webhook/BusinessMart	No documentation available.
POST Webhook/Hatchit	No documentation available.
POST Webhook/Bizben	No documentation available.
POST Webhook/ThirdParty	No documentation available.
POST Webhook/ZohoCRM	No documentation available.
POST Webhook/SaveIntegrationProviderMessage	No documentation available.
GET Webhook/GetClientIpAddressFromRequest	No documentation available.

Fcbb

API	Description
GET Fcbb/GetCategories	No documentation available.
GET Fcbb/GetStates	No documentation available.
GET Fcbb/GetSorts	No documentation available.
GET Fcbb/GetExpirations	No documentation available.
GET Fcbb/GetPriceRange	No documentation available.
GET Fcbb/GetDropDownData	No documentation available.
GET Fcbb/GetCorporateOfficeLocations?WebsiteID={WebsiteID}	No documentation available.
GET Fcbb/InitializeListingsStructureInMemoryCache	No documentation available.
POST Fcbb/GetAllBusinessListings	No documentation available.
POST Fcbb/GetListings	No documentation available.
GET Fcbb/GetListingHighlights	No documentation available.
POST Fcbb/GetSoldListings	No documentation available.
GET Fcbb/GetSoldListingDetails	No documentation available.
GET Fcbb/GetListingDetail	No documentation available.
GET Fcbb/GetListingResources	No documentation available.
GET Fcbb/GetListingResource	No documentation available.
POST Fcbb/SubmitBusinessAlertForm	No documentation available.
POST Fcbb/SubmitRequestMoreInfoForm	No documentation available.
POST Fcbb/SubmitSellYourBusinessForm	No documentation available.
GET Fcbb/GetOfficeLocations	No documentation available.
GET Fcbb/GetAgentSites	No documentation available.
POST Fcbb/SubmitValueYourBusinessForm	No documentation available.
POST Fcbb/SubmitContactUsForm	No documentation available.
GET Fcbb/NDAProcess?businessListingID={businessListingID}&resourceID={resourceID}&omsBuyerEngagementID={omsBuyerEngagementID}&sourceID={sourceID}&ownerProfileId={ownerProfileId}	No documentation available.
POST Fcbb/SubmitNDA	No documentation available.
POST Fcbb/Signature	No documentation available.
POST Fcbb/SubmitBuyerSurvey	No documentation available.
GET Fcbb/AddListingToExistingNDA?OmsListingID={OmsListingID}&OmsBuyerConfidID={OmsBuyerConfidID}&IsProcess={IsProcess}	No documentation available.
GET Fcbb/GetCBPDocumentDetail?SecureAccessLinkID={SecureAccessLinkID}	No documentation available.
GET Fcbb/RequestToIncreaseCBPDownloadLimit?secureAccessLinkID={secureAccessLinkID}	No documentation available.
GET Fcbb/DownloadSecureAccessFile?SecureAccessLinkID={SecureAccessLinkID}	No documentation available.
GET Fcbb/AssociatedWebsites	No documentation available.
GET Fcbb/AssociatedWebsiteReferenceItems	No documentation available.
GET Fcbb/ClearListingApiOmsEsignatureTemplatesSessionCacheKey	No documentation available.
GET Fcbb/ResetApiSaveAndResetLogs	No documentation available.
GET Fcbb/FcbbSystemSettingReaderClearCache	No documentation available.
GET Fcbb/GetClientIpAddressFromRequest	No documentation available.

Geo

API	Description
GET Geo/Countries	No documentation available.
GET Geo/GetClientIpAddressFromRequest	No documentation available.