| 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 | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| ContractNo | query | string | No | |
| ContractNoStartsWith | query | string | No | |
| ContractNoEndsWith | query | string | No | |
| ContractNoContains | query | string | No | |
| ContractNoLike | query | string | No | |
| ContractNoBetween | query | string[] | No | |
| ContractNoIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | 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 | |
| CurrencyDecimalPlaces | query | short? | No | |
| CurrencyDecimalPlacesGreaterThanOrEqualTo | query | short? | No | |
| CurrencyDecimalPlacesGreaterThan | query | short? | No | |
| CurrencyDecimalPlacesLessThan | query | short? | No | |
| CurrencyDecimalPlacesLessThanOrEqualTo | query | short? | No | |
| CurrencyDecimalPlacesNotEqualTo | query | short? | No | |
| CurrencyDecimalPlacesBetween | query | Nullable<Int16>[] | No | |
| CurrencyDecimalPlacesIn | query | Nullable<Int16>[] | No | |
| CurrencyRate | query | decimal? | No | |
| CurrencyRateGreaterThanOrEqualTo | query | decimal? | No | |
| CurrencyRateGreaterThan | query | decimal? | No | |
| CurrencyRateLessThan | query | decimal? | No | |
| CurrencyRateLessThanOrEqualTo | query | decimal? | No | |
| CurrencyRateNotEqualTo | query | decimal? | No | |
| CurrencyRateBetween | query | Nullable<Decimal>[] | No | |
| CurrencyRateIn | query | Nullable<Decimal>[] | No | |
| FXAmount | query | decimal? | No | |
| FXAmountGreaterThanOrEqualTo | query | decimal? | No | |
| FXAmountGreaterThan | query | decimal? | No | |
| FXAmountLessThan | query | decimal? | No | |
| FXAmountLessThanOrEqualTo | query | decimal? | No | |
| FXAmountNotEqualTo | query | decimal? | No | |
| FXAmountBetween | query | Nullable<Decimal>[] | No | |
| FXAmountIn | query | Nullable<Decimal>[] | No | |
| HomeAmount | query | decimal? | No | |
| HomeAmountGreaterThanOrEqualTo | query | decimal? | No | |
| HomeAmountGreaterThan | query | decimal? | No | |
| HomeAmountLessThan | query | decimal? | No | |
| HomeAmountLessThanOrEqualTo | query | decimal? | No | |
| HomeAmountNotEqualTo | query | decimal? | No | |
| HomeAmountBetween | query | Nullable<Decimal>[] | No | |
| HomeAmountIn | query | Nullable<Decimal>[] | No | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| InitiatedDate | query | DateTime? | No | |
| InitiatedDateGreaterThanOrEqualTo | query | DateTime? | No | |
| InitiatedDateGreaterThan | query | DateTime? | No | |
| InitiatedDateLessThan | query | DateTime? | No | |
| InitiatedDateLessThanOrEqualTo | query | DateTime? | No | |
| InitiatedDateNotEqualTo | query | DateTime? | No | |
| InitiatedDateBetween | query | DateTime[] | No | |
| InitiatedDateIn | query | DateTime[] | No | |
| StartDate | query | DateTime? | No | |
| StartDateGreaterThanOrEqualTo | query | DateTime? | No | |
| StartDateGreaterThan | query | DateTime? | No | |
| StartDateLessThan | query | DateTime? | No | |
| StartDateLessThanOrEqualTo | query | DateTime? | No | |
| StartDateNotEqualTo | query | DateTime? | No | |
| StartDateBetween | query | DateTime[] | No | |
| StartDateIn | query | DateTime[] | No | |
| EndDate | query | DateTime? | No | |
| EndDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EndDateGreaterThan | query | DateTime? | No | |
| EndDateLessThan | query | DateTime? | No | |
| EndDateLessThanOrEqualTo | query | DateTime? | No | |
| EndDateNotEqualTo | query | DateTime? | No | |
| EndDateBetween | query | DateTime[] | No | |
| EndDateIn | query | DateTime[] | No | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | byte[] | No | |
| StatusIn | query | byte[] | No | |
| AutoCloseContract | query | byte? | No | |
| AutoCloseContractGreaterThanOrEqualTo | query | byte? | No | |
| AutoCloseContractGreaterThan | query | byte? | No | |
| AutoCloseContractLessThan | query | byte? | No | |
| AutoCloseContractLessThanOrEqualTo | query | byte? | No | |
| AutoCloseContractNotEqualTo | query | byte? | No | |
| AutoCloseContractBetween | query | byte[] | No | |
| AutoCloseContractIn | query | byte[] | No | |
| HR_Staff_RecID_CreatedBy | query | string | No | |
| HR_Staff_RecID_CreatedByStartsWith | query | string | No | |
| HR_Staff_RecID_CreatedByEndsWith | query | string | No | |
| HR_Staff_RecID_CreatedByContains | query | string | No | |
| HR_Staff_RecID_CreatedByLike | query | string | No | |
| HR_Staff_RecID_CreatedByBetween | query | string[] | No | |
| HR_Staff_RecID_CreatedByIn | query | string[] | No | |
| HR_Staff_RecID_LastSavedBy | query | string | No | |
| HR_Staff_RecID_LastSavedByStartsWith | query | string | No | |
| HR_Staff_RecID_LastSavedByEndsWith | query | string | No | |
| HR_Staff_RecID_LastSavedByContains | query | string | No | |
| HR_Staff_RecID_LastSavedByLike | query | string | No | |
| HR_Staff_RecID_LastSavedByBetween | query | string[] | No | |
| HR_Staff_RecID_LastSavedByIn | query | string[] | 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 | |
| LastSavedDateTime | form | DateTime | No | |
| ContractNo | form | string | No | |
| Description | form | string | No | |
| FX_Main_RecID | form | string | No | |
| CurrencyDecimalPlaces | form | short? | No | |
| CurrencyRate | form | decimal? | No | |
| FXAmount | form | decimal? | No | |
| HomeAmount | form | decimal? | No | |
| Reference | form | string | No | |
| InitiatedDate | form | DateTime | No | |
| StartDate | form | DateTime | No | |
| EndDate | form | DateTime | No | |
| Status | form | byte | No | |
| AutoCloseContract | form | byte | No | |
| HR_Staff_RecID_CreatedBy | form | string | No | |
| HR_Staff_RecID_LastSavedBy | form | string | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/CR_ForwardCoverQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"ContractNo":"String","ContractNoStartsWith":"String","ContractNoEndsWith":"String","ContractNoContains":"String","ContractNoLike":"String","ContractNoBetween":["String"],"ContractNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"FX_Main_RecID":"String","FX_Main_RecIDStartsWith":"String","FX_Main_RecIDEndsWith":"String","FX_Main_RecIDContains":"String","FX_Main_RecIDLike":"String","FX_Main_RecIDBetween":["String"],"FX_Main_RecIDIn":["String"],"CurrencyDecimalPlaces":0,"CurrencyDecimalPlacesGreaterThanOrEqualTo":0,"CurrencyDecimalPlacesGreaterThan":0,"CurrencyDecimalPlacesLessThan":0,"CurrencyDecimalPlacesLessThanOrEqualTo":0,"CurrencyDecimalPlacesNotEqualTo":0,"CurrencyDecimalPlacesBetween":[0],"CurrencyDecimalPlacesIn":[0],"CurrencyRate":0,"CurrencyRateGreaterThanOrEqualTo":0,"CurrencyRateGreaterThan":0,"CurrencyRateLessThan":0,"CurrencyRateLessThanOrEqualTo":0,"CurrencyRateNotEqualTo":0,"CurrencyRateBetween":[0],"CurrencyRateIn":[0],"FXAmount":0,"FXAmountGreaterThanOrEqualTo":0,"FXAmountGreaterThan":0,"FXAmountLessThan":0,"FXAmountLessThanOrEqualTo":0,"FXAmountNotEqualTo":0,"FXAmountBetween":[0],"FXAmountIn":[0],"HomeAmount":0,"HomeAmountGreaterThanOrEqualTo":0,"HomeAmountGreaterThan":0,"HomeAmountLessThan":0,"HomeAmountLessThanOrEqualTo":0,"HomeAmountNotEqualTo":0,"HomeAmountBetween":[0],"HomeAmountIn":[0],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"InitiatedDate":"0001-01-01T00:00:00.0000000","InitiatedDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","InitiatedDateGreaterThan":"0001-01-01T00:00:00.0000000","InitiatedDateLessThan":"0001-01-01T00:00:00.0000000","InitiatedDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","InitiatedDateNotEqualTo":"0001-01-01T00:00:00.0000000","InitiatedDateBetween":["0001-01-01T00:00:00.0000000"],"InitiatedDateIn":["0001-01-01T00:00:00.0000000"],"StartDate":"0001-01-01T00:00:00.0000000","StartDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateGreaterThan":"0001-01-01T00:00:00.0000000","StartDateLessThan":"0001-01-01T00:00:00.0000000","StartDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateBetween":["0001-01-01T00:00:00.0000000"],"StartDateIn":["0001-01-01T00:00:00.0000000"],"EndDate":"0001-01-01T00:00:00.0000000","EndDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateGreaterThan":"0001-01-01T00:00:00.0000000","EndDateLessThan":"0001-01-01T00:00:00.0000000","EndDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateNotEqualTo":"0001-01-01T00:00:00.0000000","EndDateBetween":["0001-01-01T00:00:00.0000000"],"EndDateIn":["0001-01-01T00:00:00.0000000"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","AutoCloseContract":0,"AutoCloseContractGreaterThanOrEqualTo":0,"AutoCloseContractGreaterThan":0,"AutoCloseContractLessThan":0,"AutoCloseContractLessThanOrEqualTo":0,"AutoCloseContractNotEqualTo":0,"AutoCloseContractBetween":"AA==","AutoCloseContractIn":"AA==","HR_Staff_RecID_CreatedBy":"String","HR_Staff_RecID_CreatedByStartsWith":"String","HR_Staff_RecID_CreatedByEndsWith":"String","HR_Staff_RecID_CreatedByContains":"String","HR_Staff_RecID_CreatedByLike":"String","HR_Staff_RecID_CreatedByBetween":["String"],"HR_Staff_RecID_CreatedByIn":["String"],"HR_Staff_RecID_LastSavedBy":"String","HR_Staff_RecID_LastSavedByStartsWith":"String","HR_Staff_RecID_LastSavedByEndsWith":"String","HR_Staff_RecID_LastSavedByContains":"String","HR_Staff_RecID_LastSavedByLike":"String","HR_Staff_RecID_LastSavedByBetween":["String"],"HR_Staff_RecID_LastSavedByIn":["String"],"RowHash":"AA==","Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"RecID":"String","ContractNo":"String","Description":"String","FX_Main_RecID":"String","CurrencyDecimalPlaces":0,"CurrencyRate":0,"FXAmount":0,"HomeAmount":0,"Reference":"String","HR_Staff_RecID_CreatedBy":"String","HR_Staff_RecID_LastSavedBy":"String","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"}}}