ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

MubarkiaMap

API	Description
GET API/MubarkiaMap/MubarkiaMap?key={key}&PageIndex={PageIndex}	- Wrong Key -9 - Error: return -1

Produts

API	Description
GET API/Produts/GetProducts?productId={productId}&categoryId={categoryId}&ShopsId={ShopsId}&merchantId={merchantId}&currencyId={currencyId}&pageIndex={pageIndex}&loginUserId={loginUserId}&keyword={keyword}&appLang={appLang}&key={key}	-9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error
GET API/Produts/GetOfferedProducts?productId={productId}&categoryId={categoryId}&ShopsId={ShopsId}&merchantId={merchantId}&currencyId={currencyId}&pageIndex={pageIndex}&loginUserId={loginUserId}&keyword={keyword}&appLang={appLang}&key={key}	-9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error
GET API/Produts/GetRelatedProducts?productId={productId}&loginUserId={loginUserId}&pageIndex={pageIndex}&currencyId={currencyId}&appLang={appLang}&key={key}	-9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error ///
GET API/Produts/GetProductsByCategory?productId={productId}&categoryId={categoryId}&merchantId={merchantId}&currencyId={currencyId}&pageIndex={pageIndex}&loginUserId={loginUserId}&keyword={keyword}&appLang={appLang}&key={key}	Get all products by categoryId and loginUserId. -9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error
GET API/Produts/GetHomeCategoriesProducts?loginUserId={loginUserId}&currencyId={currencyId}&key={key}	Get all products by categoryId and loginUserId. -9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error
GET API/Produts/GetNewArrivals?currencyId={currencyId}&loginUserId={loginUserId}&key={key}	Get new arrivals products by loginUserId -9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error
GET API/Produts/GetFavorites?pageIndex={pageIndex}&userId={userId}&currencyId={currencyId}&key={key}	Get all favorite products by loginUserId. -9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error
GET API/Produts/GetProductPhotos?productId={productId}&key={key}	Get all products photos by productId -9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error ///
POST API/Produts/SetProductFavorite?productId={productId}&userId={userId}&key={key}	"Set product is favorite by productId and userId." -9 >> Wrong Key -2 >> No data meet passed parameter -1 >> Error ///

Countries

API	Description
GET API/Countries/GetCountry?key={key}	Get Country

DevicesTokens

API	Description
POST API/DevicesTokens/AddToken?key={key}	No documentation available.
POST API/DevicesTokens/AddTokenForAndroid?key={key}	No documentation available.

Advertisment

API	Description
GET API/Advertisment/GetHomeSlider?shopId={shopId}&key={key}	- Wrong Key -9 - Error: return -1
GET API/Advertisment/GetHomeSlider2?shopId={shopId}&key={key}	- Wrong Key -9 - Error: return -1
GET API/Advertisment/GetAdvertisment?AdsId={AdsId}&ShowPlaceId={ShowPlaceId}&AdsTypeid={AdsTypeid}&CategoryId={CategoryId}&key={key}	No documentation available.

Users

UsersController

API	Description
GET API/Users/RegisterForMubarakiya	No documentation available.
POST API/Users/Register?key={key}&deviceToken={deviceToken}	UserType 1 for Normal User, 2 for Merchant Number greater than 0 (user id) -> Success -2 -> Required field is empty -3 -> Phone exist -4 -> Email exist -5 -> Username exist -1 -> Error
GET API/Users/LoginByUserName?userName={userName}&password={password}&deviceToken={deviceToken}&key={key}	Number greater than 0 (user id) -> Success -2 -> Required field is empty -3 -> Not exist -4 -> Wrong password-5 -> Not activated -1 -> Error
GET API/Users/GetUserById?userId={userId}&key={key}	-2 -> Required field is empty -3 -> User not exist -1 -> Error -9 -> wrong Key
POST API/Users/Logout?userId={userId}&deviceToken={deviceToken}&key={key}	Number greater than 0 (user id) -> Success -2 -> Required field is empty -1 -> Error
POST API/Users/ForgetPassword?Email={Email}&key={key}	1 -> Success -2 -> Email is empty -3 -> Not exist -1 -> Error
POST API/Users/EditUser?key={key}	Number greater than 0 (user id) -> Success -2 -> Required field is empty -3 -> UserName exist -4 -> mobile already exists -5 -> Email exist -1 -> Error BirthDate format will be like '04/20/2018'You can set password with blank if you do not want to update.
POST API/Users/ChangePassword?userId={userId}&oldPassword={oldPassword}&password={password}&key={key}	Number greater than 0 (user id) -> Success -2 -> Required field is empty -3 -> User not exist -4 -> Password wrong -1 -> Error
POST API/Users/Deactivate?userId={userId}&password={password}&key={key}	Number greater than 0 (user id) -> Success -2 -> Required field is empty -3 -> User not exist -4 -> Password wrong -1 -> Error

PaymentMethods

API	Description
GET API/PaymentMethods/GetPaymentMethods?key={key}

General

API	Description
GET API/General/ImportantNumber?key={key}&PageIndex={PageIndex}	- Success: return list of mubarkiaImportantNumber - Wrong Key -9 - Error: return -1
GET API/General/SellDetails?key={key}	Get all general settings.
GET API/General/colors?key={key}	Get all general settings.
GET API/General/GetSettings?key={key}	Get all general settings.
GET API/General/AboutMubarkia?key={key}	- Success: return list of AboutMubarkiaiteemlist - Wrong Key -9 - Error: return -1
GET API/General/MubarkiaContactUs?key={key}	- Success: return list of AboutMubarkiaiteemlist - Wrong Key -9 - Error: return -1
GET API/General/SendContactUsEmail?key={key}&name={name}&mail={mail}&message={message}	1 >> operaton completed successfully -1 > operation filed
GET API/General/MubarkiaHome?key={key}	slider in the first home page -1 when no data exist

Categories

API	Description
GET API/Categories/GetCategories?key={key}&Type={Type}&PageIndex={PageIndex}&ShownIn={ShownIn}	categoryType=1 > mainCategory , categoryType=2 > other Category -Wrong Key 9 - Error: return -1

Offers

API	Description
GET API/Offers/GetOffers?OfferId={OfferId}&countryId={countryId}&pageIndex={pageIndex}&key={key}

Shops

API	Description
GET API/Shops/GetShop?key={key}&shop_id={shop_id}&userid={userid}&IsSpecial={IsSpecial}&ShownIn={ShownIn}	- Wrong Key return -9 - No data meet passed parameter -2 - No data meet passed parameter -2 - Error: return -1
GET API/Shops/GetShopsUnderCategory?key={key}&_CategoryId={_CategoryId}&PageIndex={PageIndex}&keyword={keyword}&type={type}&userid={userid}&SellType={SellType}&ShownIn={ShownIn}	- Wrong Key return -9 - No data meet passed parameter -2 - Error: return -1
GET API/Shops/MakeShopFavorite?key={key}&shopId={shopId}&userId={userId}	1 >> this shop become in user favorit List successfully 0 >> this shop become unfavorit for user -2 >> No data meet passed parameter -9 >> Wrong Key -3 >> This shop does not exist -4 >> This user does not exist - Error: return -1 ///
GET API/Shops/MyFavorites?key={key}&userId={userId}	- Wrong Key return -9 - Error: return -1
POST API/Shops/DeleteShopPhoto	- Error: return -1 - Wrong Key -9
POST API/Shops/DeleteadsPhoto	- Wrong Key -9 - Error: return -1

Files

API	Description
POST API/Files/UploadPhoto?key={key}&path={path}	Upload Post Photo.
POST API/Files/UploadAnyPhoto?key={key}&Path={Path}	No documentation available.
POST API/Files/DeletePhoto?key={key}&file={file}	Upload Post Photo.
POST API/Files/DeleteAnyPhoto?key={key}&Path={Path}&file={file}	Upload Post Photo.
POST API/Files/DeleteShopPhoto
POST API/Files/DeleteadsPhoto

Areas

API	Description
GET API/Areas/GetAreas?CityId={CityId}&key={key}

ContentPages

API	Description
GET API/ContentPages/GetCPages?pageId={pageId}&key={key}	Set pageId with 0 to get all pages. 1 => About Us page 2 => FAQ page 3 => Terms page 4 => Policy page

Orders

API	Description
GET API/Orders/ValidateCoupon?userId={userId}&couponNo={couponNo}&currencyId={currencyId}&key={key}&amount={amount}	No documentation available.
GET API/Orders/ValidateOrder?userId={userId}&addId={addId}&couponNo={couponNo}&paymentMethodId={paymentMethodId}&currencyId={currencyId}&proIds={proIds}&colors={colors}&qtys={qtys}&prices={prices}&appLang={appLang}&key={key}	To validate order 1 -> Success -2 -> Required field is empty -3 -> Currency not exist -4 -> coupon not valid -5 -> coupon used -6 -> coupon amount more than total amount -1 -> Error
POST API/Orders/MakeOrder?key={key}	orderId greater than 0 -> Success -2 -> Required field is empty -3 -> Currency not exist -4 -> Coupon not valid -5 -> Coupon used -6 -> Coupon greater than the total -1 -> Error
POST API/Orders/ReOrder?key={key}	orderId greater than 0 -> Success 2 -> Required field is empty -3 -> Currency not exist -4 -> Coupon not valid -5 -> Coupon used -6 -> Coupon greater than the total -7 -> Order Null -1 -> Error
GET API/Orders/InsertAddress?userId={userId}&areaId={areaId}&block={block}&house={house}&building={building}&floor={floor}&apartment={apartment}&addressDetails={addressDetails}&key={key}&street={street}&Avenue={Avenue}&isDefault={isDefault}	addId greater than 0 -> Success -2 -> Required field is empty -2 -> Required field is empty -3 -> User not exist -1 -> Error
GET API/Orders/GetOrders?orderId={orderId}&userId={userId}&key={key}	Get all orders by orderId and userId
GET API/Orders/GetAddresses?addId={addId}&userId={userId}&key={key}	Get all addresses by addressId and userId
POST API/Orders/SetAddressDefault?addId={addId}&userId={userId}&key={key}	Set address is default by addId and userId.
GET API/Orders/GetDefaultAddress?userId={userId}&key={key}	Get default address by userId-2 -> userId is 0 -1 -> Error
GET API/Orders/GetDeliveryShifts?key={key}	No documentation available.

Cities

API	Description
GET API/Cities/GetCities?CountryId={CountryId}&key={key}	if CountyId equal zero will return all cities