Read Settings

Parameters

Path Params
yourCompany:	string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Settings will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Settings

Query Params
settingName:	string In this parameter settingname needs to be provided with module if needed to fetch related details. To fetch Settings related to Currency Configuration, the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Settings?settingName=currency-configuration-settings&key=xyzkey
module:	string In this parameter module needs to be provided with settingName to fetch related details. To fetch Settings related to custom fields of Products module , the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Settings?settingName=custom-field-settings&module=Products&key=xyzkey
username:	string In this parameter username needs to be provided whenever it is required with settingName and module to fetch related details. To fetch Settings related to fields accessiblity of Products module , the following url must be used https://xyzcompany.agiliron.net/agiliron/api-40/Settings?settingName=field-accessibility&module=Products&username=xyz&key=xyzkey

Query Params

settingName:

string
In this parameter settingname needs to be provided with module if needed to fetch related details.

To fetch Settings related to Currency Configuration, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Settings?settingName=currency-configuration-settings&key=xyzkey

module:

string
In this parameter module needs to be provided with settingName to fetch related details.

To fetch Settings related to custom fields of Products module , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Settings?settingName=custom-field-settings&module=Products&key=xyzkey

username:

string
In this parameter username needs to be provided whenever it is required with settingName and module to fetch related details.

To fetch Settings related to fields accessiblity of Products module , the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Settings?settingName=field-accessibility&module=Products&username=xyz&key=xyzkey

Header Params
key:	string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.

Query Auth
key:	string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth
apiKey:	string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
    "CurrencyConfiguration": {
        "Currency": [
            {
                "CurrencyName": "US Dollar",
                "CurrencyCode": "USD",
                "CurrencySymbol": "$",
                "ExchangeRate": "1.00000",
                "IsDefault": "true"
            },
            {
                "CurrencyName": "CAD",
                "CurrencyCode": "CAD",
                "CurrencySymbol": "C$",
                "ExchangeRate": "0.78000",
                "IsDefault": null
            },
            {
                "CurrencyName": "Pound Sterling",
                "CurrencyCode": "GBP",
                "CurrencySymbol": "u00a3",
                "ExchangeRate": "1.13000",
                "IsDefault": null
            },
            {
                "CurrencyName": "EUR",
                "CurrencyCode": "EUR",
                "CurrencySymbol": "$",
                "ExchangeRate": "1.55000",
                "IsDefault": null
            }
        ],
        "TotalRecords": "4",
        "CurrentPage": "1",
        "TotalPages": "1",
        "PageSize": "50"
    }
}

<CurrencyConfiguration>
    <Currency>
        <CurrencyName>US Dollar</CurrencyName>
        <CurrencyCode>USD</CurrencyCode>
        <CurrencySymbol>$</CurrencySymbol>
        <ExchangeRate>1.00000</ExchangeRate>
        <IsDefault>true</IsDefault>
    </Currency>
    <Currency>
        <CurrencyName>CAD</CurrencyName>
        <CurrencyCode>CAD</CurrencyCode>
        <CurrencySymbol>C$</CurrencySymbol>
        <ExchangeRate>0.78000</ExchangeRate>
        <IsDefault></IsDefault>
    </Currency>
    <Currency>
        <CurrencyName>Pound Sterling</CurrencyName>
        <CurrencyCode>GBP</CurrencyCode>
        <CurrencySymbol>£</CurrencySymbol>
        <ExchangeRate>1.13000</ExchangeRate>
        <IsDefault></IsDefault>
    </Currency>
    <Currency>
        <CurrencyName>EUR</CurrencyName>
        <CurrencyCode>EUR</CurrencyCode>
        <CurrencySymbol>$</CurrencySymbol>
        <ExchangeRate>1.55000</ExchangeRate>
        <IsDefault></IsDefault>
    </Currency>
    <TotalRecords>4</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</CurrencyConfiguration>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Settings"> 
       <method name="GET">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="settingName" type="xsd:string" style="query"/>
           <param name="module" type="xsd:string" style="query"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>