Needio.Services

<back to all web services

GetSystemSettingsRequest

The following routes are available for this service:
All Verbs/GetSystemSettings/
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetSystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
SystemSettingformSystemSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
SystemSettings Parameters:
NameParameterData TypeRequiredDescription
ServiceVersionformstringNo
MinClientVersionformstringNo
MaxClientVersionformstringNo
GoogleMapKeyformstringNo
GoogleMapKeyForWebformstringNo
GooglePlusKeyformstringNo
GooglePlusKeyForWebformstringNo
FacebookKeyformstringNo
FacebookSecretformstringNo
FCMKeyformstringNo
EndPointsformEndPointSettingsNo
BadgeTypesformList<BadgeTypeDTO>No
PaymentSystemTypeformstringNo
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 /GetSystemSettings/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	start: 2020-07-03T23:08:31.1563023+03:00
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SystemSetting: 
	{
		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
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	}
}