Needio.Services

<back to all web services

GetSystemSettingsRequest

The following routes are available for this service:
All Verbs/GetSystemSettings/
GetSystemSettingsRequest Parameters:
NameParameterData TypeRequiredDescription
PlatformquerystringNo
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 .xml suffix or ?format=xml

HTTP + XML

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

POST /GetSystemSettings/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSystemSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <Platform>String</Platform>
</GetSystemSettingsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSystemSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <BBSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:AutoApproveReportForCustomer>false</d2p1:AutoApproveReportForCustomer>
    <d2p1:CreateKeyManForFromHomeServices>false</d2p1:CreateKeyManForFromHomeServices>
    <d2p1:DeliveryTimeOutDays>0</d2p1:DeliveryTimeOutDays>
    <d2p1:DisableCancelAfterDays>0</d2p1:DisableCancelAfterDays>
    <d2p1:KeyReminder1AtDay>0</d2p1:KeyReminder1AtDay>
    <d2p1:KeyReminder2AtDay>0</d2p1:KeyReminder2AtDay>
    <d2p1:KeyShippingEndDateInDays>0</d2p1:KeyShippingEndDateInDays>
    <d2p1:KeyShippingStartDateInDays>0</d2p1:KeyShippingStartDateInDays>
    <d2p1:OfferReminderAtDay>0</d2p1:OfferReminderAtDay>
    <d2p1:OfferTimeOutDays>0</d2p1:OfferTimeOutDays>
    <d2p1:SendKeyManagementNotification>false</d2p1:SendKeyManagementNotification>
    <d2p1:ServiceApproveMaxMonths>0</d2p1:ServiceApproveMaxMonths>
    <d2p1:ServiceApproveMinDays>0</d2p1:ServiceApproveMinDays>
    <d2p1:ServiceAutoApproveInDays>0</d2p1:ServiceAutoApproveInDays>
    <d2p1:ServiceOfferReminderAtDay>0</d2p1:ServiceOfferReminderAtDay>
    <d2p1:ServiceOfferTimeOutDays>0</d2p1:ServiceOfferTimeOutDays>
    <d2p1:ShowKeyManagementTimeline>false</d2p1:ShowKeyManagementTimeline>
    <d2p1:UserAddressEditSetting>String</d2p1:UserAddressEditSetting>
  </BBSettings>
  <CargoSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:GlobalCargoCost>0</d2p1:GlobalCargoCost>
    <d2p1:GlobalCargoLimit>0</d2p1:GlobalCargoLimit>
    <d2p1:PreferedReturnShipmentMethodId>0</d2p1:PreferedReturnShipmentMethodId>
    <d2p1:PreferedShipmentMethodId>0</d2p1:PreferedShipmentMethodId>
  </CargoSettings>
  <ImageParams xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:AkakceJson>String</d2p1:AkakceJson>
    <d2p1:Basket>String</d2p1:Basket>
    <d2p1:DetailBig>String</d2p1:DetailBig>
    <d2p1:DetailSmall>String</d2p1:DetailSmall>
    <d2p1:List>String</d2p1:List>
    <d2p1:Notification>String</d2p1:Notification>
    <d2p1:Preview>String</d2p1:Preview>
    <d2p1:Slider>String</d2p1:Slider>
  </ImageParams>
  <SystemSetting xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:AllowInstallment>false</d2p1:AllowInstallment>
    <d2p1:BadgeTypes>
      <d2p1:BadgeTypeDTO>
        <d2p1:BadgeCode>String</d2p1:BadgeCode>
        <d2p1:BadgeColor>String</d2p1:BadgeColor>
        <d2p1:BadgeText>String</d2p1:BadgeText>
        <d2p1:BadgeTypeId>0</d2p1:BadgeTypeId>
        <d2p1:Priority>0</d2p1:Priority>
      </d2p1:BadgeTypeDTO>
    </d2p1:BadgeTypes>
    <d2p1:ChatSettings>
      <d2p1:SystemStoreId>0</d2p1:SystemStoreId>
    </d2p1:ChatSettings>
    <d2p1:EndPoints>
      <d2p1:BaseServicesEndPoint>String</d2p1:BaseServicesEndPoint>
      <d2p1:BaseWebEndPoint>String</d2p1:BaseWebEndPoint>
      <d2p1:ChatServicesEndPoint>String</d2p1:ChatServicesEndPoint>
      <d2p1:ChatSocketEndPoint>String</d2p1:ChatSocketEndPoint>
      <d2p1:ContentEndPoint>String</d2p1:ContentEndPoint>
      <d2p1:ElasticSearchUrl>String</d2p1:ElasticSearchUrl>
      <d2p1:ImageServicesEndPoint>String</d2p1:ImageServicesEndPoint>
      <d2p1:KbEndPoint>String</d2p1:KbEndPoint>
      <d2p1:PaymentEndPoint>String</d2p1:PaymentEndPoint>
      <d2p1:PrivacyPolicyUrl>String</d2p1:PrivacyPolicyUrl>
      <d2p1:SSEEndPoint>String</d2p1:SSEEndPoint>
      <d2p1:TermsOfServiceUrl>String</d2p1:TermsOfServiceUrl>
    </d2p1:EndPoints>
    <d2p1:FCMKey>String</d2p1:FCMKey>
    <d2p1:FacebookKey>String</d2p1:FacebookKey>
    <d2p1:FacebookSecret>String</d2p1:FacebookSecret>
    <d2p1:GoogleMapKey>String</d2p1:GoogleMapKey>
    <d2p1:GoogleMapKeyForWeb>String</d2p1:GoogleMapKeyForWeb>
    <d2p1:GooglePlusKey>String</d2p1:GooglePlusKey>
    <d2p1:GooglePlusKeyForWeb>String</d2p1:GooglePlusKeyForWeb>
    <d2p1:MaxClientVersion>String</d2p1:MaxClientVersion>
    <d2p1:MinClientVersion>String</d2p1:MinClientVersion>
    <d2p1:PaymentSystemType>String</d2p1:PaymentSystemType>
    <d2p1:ServiceStatus>Online</d2p1:ServiceStatus>
    <d2p1:ServiceVersion>String</d2p1:ServiceVersion>
  </SystemSetting>
  <WebExtensionsSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ShowStoreViews>false</d2p1:ShowStoreViews>
    <d2p1:UseAppleLogin>false</d2p1:UseAppleLogin>
    <d2p1:UseFacebookLogin>false</d2p1:UseFacebookLogin>
    <d2p1:UseGTM>false</d2p1:UseGTM>
    <d2p1:UseGoogleLogin>false</d2p1:UseGoogleLogin>
    <d2p1:UseHotjar>false</d2p1:UseHotjar>
    <d2p1:UseInsider>false</d2p1:UseInsider>
    <d2p1:UseSegmentify>false</d2p1:UseSegmentify>
    <d2p1:UseTawkTo>false</d2p1:UseTawkTo>
  </WebExtensionsSettings>
</GetSystemSettingsResponse>