GET | /Queries/FX_CurrencyRates | Retrieves a list of currency rates. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
FX_Main_RecID | query | string | No | |
FX_Main_RecIDStartsWith | query | string | No | |
FX_Main_RecIDEndsWith | query | string | No | |
FX_Main_RecIDContains | query | string | No | |
FX_Main_RecIDLike | query | string | No | |
FX_Main_RecIDBetween | query | string[] | No | |
FX_Main_RecIDIn | query | string[] | No | |
DateEntered | query | DateTime? | No | |
DateEnteredGreaterThanOrEqualTo | query | DateTime? | No | |
DateEnteredGreaterThan | query | DateTime? | No | |
DateEnteredLessThan | query | DateTime? | No | |
DateEnteredLessThanOrEqualTo | query | DateTime? | No | |
DateEnteredNotEqualTo | query | DateTime? | No | |
DateEnteredBetween | query | DateTime[] | No | |
DateEnteredIn | query | DateTime[] | No | |
EffectiveDate | query | DateTime? | No | |
EffectiveDateGreaterThanOrEqualTo | query | DateTime? | No | |
EffectiveDateGreaterThan | query | DateTime? | No | |
EffectiveDateLessThan | query | DateTime? | No | |
EffectiveDateLessThanOrEqualTo | query | DateTime? | No | |
EffectiveDateNotEqualTo | query | DateTime? | No | |
EffectiveDateBetween | query | DateTime[] | No | |
EffectiveDateIn | query | DateTime[] | No | |
EffectiveDateEnd | query | DateTime? | No | |
EffectiveDateEndGreaterThanOrEqualTo | query | DateTime? | No | |
EffectiveDateEndGreaterThan | query | DateTime? | No | |
EffectiveDateEndLessThan | query | DateTime? | No | |
EffectiveDateEndLessThanOrEqualTo | query | DateTime? | No | |
EffectiveDateEndNotEqualTo | query | DateTime? | No | |
EffectiveDateEndBetween | query | DateTime[] | No | |
EffectiveDateEndIn | query | DateTime[] | No | |
TransactionRate | query | decimal? | No | |
TransactionRateGreaterThanOrEqualTo | query | decimal? | No | |
TransactionRateGreaterThan | query | decimal? | No | |
TransactionRateLessThan | query | decimal? | No | |
TransactionRateLessThanOrEqualTo | query | decimal? | No | |
TransactionRateNotEqualTo | query | decimal? | No | |
TransactionRateBetween | query | Nullable<Decimal>[] | No | |
TransactionRateIn | query | Nullable<Decimal>[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | int[] | No | |
ItemNoIn | query | int[] | No | |
RowHash | query | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | form | string | No | |
FX_Main_RecID | form | string | No | |
DateEntered | form | DateTime | No | |
EffectiveDate | form | DateTime | No | |
EffectiveDateEnd | form | DateTime | No | |
TransactionRate | form | decimal? | No | |
ItemNo | form | int | No | |
RowHash | form | byte[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/FX_CurrencyRates HTTP/1.1 Host: api.jiwa.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Results":[{"RecID":"String","FX_Main_RecID":"String","TransactionRate":0,"RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}