JiwaAPI

<back to all web services

CurrencyGETRequest

Requires Authentication
The following routes are available for this service:
GET/Currencies/{CurrencyID}Retrieves a currency.
CurrencyGETRequest Parameters:
NameParameterData TypeRequiredDescription
CurrencyIDpathstringNo
Currency Parameters:
NameParameterData TypeRequiredDescription
CurrencyIDformstringNo
NameformstringNo
ShortNameformstringNo
DecimalPlacesformint?No
IsEnabledformbool?No
IsLocalformbool?No
LastSavedDateTimeformDateTime?No
RatesformList<CurrencyRate>No
CurrencyRate Parameters:
NameParameterData TypeRequiredDescription
RateIDformstringNo
DateEnteredformDateTime?No
EffectiveDateformDateTime?No
EffectiveDateEndformDateTime?No
TransactionRateformdecimal?No

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.

GET /Currencies/{CurrencyID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Currency xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Currencies">
  <_x003C_CurrencyID_x003E_k__BackingField>String</_x003C_CurrencyID_x003E_k__BackingField>
  <_x003C_DecimalPlaces_x003E_k__BackingField>0</_x003C_DecimalPlaces_x003E_k__BackingField>
  <_x003C_IsEnabled_x003E_k__BackingField>false</_x003C_IsEnabled_x003E_k__BackingField>
  <_x003C_IsLocal_x003E_k__BackingField>false</_x003C_IsLocal_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
  <_x003C_Rates_x003E_k__BackingField>
    <CurrencyRate>
      <_x003C_DateEntered_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_DateEntered_x003E_k__BackingField>
      <_x003C_EffectiveDateEnd_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_EffectiveDateEnd_x003E_k__BackingField>
      <_x003C_EffectiveDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_EffectiveDate_x003E_k__BackingField>
      <_x003C_RateID_x003E_k__BackingField>String</_x003C_RateID_x003E_k__BackingField>
      <_x003C_TransactionRate_x003E_k__BackingField>0</_x003C_TransactionRate_x003E_k__BackingField>
    </CurrencyRate>
  </_x003C_Rates_x003E_k__BackingField>
  <_x003C_ShortName_x003E_k__BackingField>String</_x003C_ShortName_x003E_k__BackingField>
</Currency>