Needio.Services

<back to all web services

GetSystemSettingsRequest

The following routes are available for this service:
All Verbs/GetSystemSettings/
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
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
ServiceVersionformstringNo
MinClientVersionformstringNo
MaxClientVersionformstringNo
GoogleMapKeyformstringNo
GoogleMapKeyForWebformstringNo
GooglePlusKeyformstringNo
GooglePlusKeyForWebformstringNo
FacebookKeyformstringNo
FacebookSecretformstringNo
FCMKeyformstringNo
EndPointsformEndPointSettingsNo
BadgeTypesformList<BadgeTypeDTO>No
PaymentSystemTypeformstringNo
AllowInstallmentformboolNo
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 .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: baseservices2.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">
  <DeviceUUID>String</DeviceUUID>
</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">
  <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>
  <SystemSetting xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.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: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: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:ServiceVersion>String</d2p1:ServiceVersion>
  </SystemSetting>
</GetSystemSettingsResponse>