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
GetSystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SystemSettingformSystemSettingsNo
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
ServiceStatuses Enum:
NameValue
Online1
OnMaintanence2
EndPointSettings Parameters:
NameParameterData TypeRequiredDescription
ChatSocketEndPointformstringNo
ChatServicesEndPointformstringNo
BaseServicesEndPointformstringNo
ImageServicesEndPointformstringNo
ContentEndPointformstringNo
BaseWebEndPointformstringNo
KbEndPointformstringNo
PaymentEndPointformstringNo
PrivacyPolicyUrlformstringNo
TermsOfServiceUrlformstringNo
ElasticSearchUrlformstringNo
BadgeTypeDTO Parameters:
NameParameterData TypeRequiredDescription
BadgeTypeIdformshortNo
BadgeCodeformstringNo
BadgeTextformstringNo
BadgeColorformstringNo
PriorityformshortNo
GetSystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SystemSettingformSystemSettingsNo

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: 2021-10-19T17:53:15.4566809+03:00,
	DeviceUUID: String,
	APIKey: 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
		},
		BadgeTypes: 
		[
			{
				BadgeTypeId: 0,
				BadgeCode: String,
				BadgeText: String,
				BadgeColor: String,
				Priority: 0
			}
		],
		PaymentSystemType: String,
		AllowInstallment: False
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}