Needio.Services

<back to all web services

GetSystemSettings2Request

The following routes are available for this service:
All Verbs/GetSystemSettings2/
GetSystemSettings2Request Parameters:
NameParameterData TypeRequiredDescription
KeyquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
GetSystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SystemSettingformSystemSettingsNo
ImageParamsformImageParamSettingsNo
CargoSettingsformCargoSettingsNo
WebExtensionsSettingsformWebExtensionsSettingsNo
BBSettingsformBBSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SystemSettings Parameters:
NameParameterData TypeRequiredDescription
ServiceStatusformServiceStatusesNo
ServiceVersionformstringNo
MinClientVersionformstringNo
MaxClientVersionformstringNo
GoogleMapKeyformstringNo
GoogleMapKeyForWebformstringNo
GooglePlusKeyformstringNo
GooglePlusKeyForWebformstringNo
FacebookKeyformstringNo
FacebookSecretformstringNo
FCMKeyformstringNo
EndPointsformEndPointSettingsNo
BadgeTypesformList<BadgeTypeDTO>No
PaymentSystemTypeformstringNo
AllowInstallmentformboolNo
ChatSettingsformChatSettingsNo
ServiceStatuses Enum:
NameValue
Online1
OnMaintanence2
EndPointSettings Parameters:
NameParameterData TypeRequiredDescription
ChatSocketEndPointformstringNo
ChatServicesEndPointformstringNo
BaseServicesEndPointformstringNo
ImageServicesEndPointformstringNo
ContentEndPointformstringNo
BaseWebEndPointformstringNo
KbEndPointformstringNo
PaymentEndPointformstringNo
PrivacyPolicyUrlformstringNo
TermsOfServiceUrlformstringNo
ElasticSearchUrlformstringNo
SSEEndPointformstringNo
BadgeTypeDTO Parameters:
NameParameterData TypeRequiredDescription
BadgeTypeIdformshortNo
BadgeCodeformstringNo
BadgeTextformstringNo
BadgeColorformstringNo
PriorityformshortNo
ChatSettings Parameters:
NameParameterData TypeRequiredDescription
SystemStoreIdformintNo
ImageParamSettings Parameters:
NameParameterData TypeRequiredDescription
ListformstringNo
DetailSmallformstringNo
DetailBigformstringNo
PreviewformstringNo
BasketformstringNo
SliderformstringNo
NotificationformstringNo
AkakceJsonformstringNo
CargoSettings Parameters:
NameParameterData TypeRequiredDescription
PreferedShipmentMethodIdformintNo
PreferedReturnShipmentMethodIdformintNo
GlobalCargoLimitformdecimalNo
GlobalCargoCostformdecimalNo
WebExtensionsSettings Parameters:
NameParameterData TypeRequiredDescription
UseInsiderformboolNo
UseHotjarformboolNo
UseSegmentifyformboolNo
UseFacebookLoginformboolNo
UseGoogleLoginformboolNo
UseAppleLoginformboolNo
UseGTMformboolNo
UseTawkToformboolNo
ShowStoreViewsformboolNo
BBSettings Parameters:
NameParameterData TypeRequiredDescription
KeyShippingStartDateInDaysformintNo
KeyShippingEndDateInDaysformintNo
DeliveryTimeOutDaysformintNo
OfferTimeOutDaysformintNo
ServiceOfferTimeOutDaysformintNo
UserAddressEditSettingformstringNo
KeyReminder1AtDayformintNo
KeyReminder2AtDayformintNo
ServiceAutoApproveInDaysformintNo
OfferReminderAtDayformintNo
ServiceOfferReminderAtDayformintNo
ServiceApproveMinDaysformintNo
ServiceApproveMaxMonthsformintNo
SendKeyManagementNotificationformboolNo
ShowKeyManagementTimelineformboolNo
AutoApproveReportForCustomerformboolNo
CreateKeyManForFromHomeServicesformboolNo
DisableCancelAfterDaysformintNo
GetSystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SystemSettingformSystemSettingsNo
ImageParamsformImageParamSettingsNo
CargoSettingsformCargoSettingsNo
WebExtensionsSettingsformWebExtensionsSettingsNo
BBSettingsformBBSettingsNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetSystemSettings2/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	start: 0001-01-01,
	DeviceUUID: String,
	APIKey: String,
	isAdmin: False,
	Cmd: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SystemSetting: 
	{
		ServiceStatus: 1,
		ServiceVersion: String,
		MinClientVersion: String,
		MaxClientVersion: String,
		GoogleMapKey: String,
		GoogleMapKeyForWeb: String,
		GooglePlusKey: String,
		GooglePlusKeyForWeb: String,
		FacebookKey: String,
		FacebookSecret: String,
		FCMKey: String,
		EndPoints: 
		{
			ChatSocketEndPoint: String,
			ChatServicesEndPoint: String,
			BaseServicesEndPoint: String,
			ImageServicesEndPoint: String,
			ContentEndPoint: String,
			BaseWebEndPoint: String,
			KbEndPoint: String,
			PaymentEndPoint: String,
			PrivacyPolicyUrl: String,
			TermsOfServiceUrl: String,
			ElasticSearchUrl: String,
			SSEEndPoint: String
		},
		BadgeTypes: 
		[
			{
				BadgeTypeId: 0,
				BadgeCode: String,
				BadgeText: String,
				BadgeColor: String,
				Priority: 0
			}
		],
		PaymentSystemType: String,
		AllowInstallment: False,
		ChatSettings: 
		{
			SystemStoreId: 0
		}
	},
	ImageParams: 
	{
		List: String,
		DetailSmall: String,
		DetailBig: String,
		Preview: String,
		Basket: String,
		Slider: String,
		Notification: String,
		AkakceJson: String
	},
	CargoSettings: 
	{
		PreferedShipmentMethodId: 0,
		PreferedReturnShipmentMethodId: 0,
		GlobalCargoLimit: 0,
		GlobalCargoCost: 0
	},
	WebExtensionsSettings: 
	{
		UseInsider: False,
		UseHotjar: False,
		UseSegmentify: False,
		UseFacebookLogin: False,
		UseGoogleLogin: False,
		UseAppleLogin: False,
		UseGTM: False,
		UseTawkTo: False,
		ShowStoreViews: False
	},
	BBSettings: 
	{
		KeyShippingStartDateInDays: 0,
		KeyShippingEndDateInDays: 0,
		DeliveryTimeOutDays: 0,
		OfferTimeOutDays: 0,
		ServiceOfferTimeOutDays: 0,
		UserAddressEditSetting: String,
		KeyReminder1AtDay: 0,
		KeyReminder2AtDay: 0,
		ServiceAutoApproveInDays: 0,
		OfferReminderAtDay: 0,
		ServiceOfferReminderAtDay: 0,
		ServiceApproveMinDays: 0,
		ServiceApproveMaxMonths: 0,
		SendKeyManagementNotification: False,
		ShowKeyManagementTimeline: False,
		AutoApproveReportForCustomer: False,
		CreateKeyManForFromHomeServices: False,
		DisableCancelAfterDays: 0
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}