Read Settings
Retrieves the details of a Settings object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
settingName: | string
|
module: | string
|
username: | string
|
Header Params | |
---|---|
key: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
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>
Updated about 21 hours ago