JiwaAPI

<back to all web services

CR_ForwardCoverQuery

Requires Authentication
CR_ForwardCoverQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
ContractNoquerystringNo
ContractNoStartsWithquerystringNo
ContractNoEndsWithquerystringNo
ContractNoContainsquerystringNo
ContractNoLikequerystringNo
ContractNoBetweenquerystring[]No
ContractNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
FX_Main_RecIDquerystringNo
FX_Main_RecIDStartsWithquerystringNo
FX_Main_RecIDEndsWithquerystringNo
FX_Main_RecIDContainsquerystringNo
FX_Main_RecIDLikequerystringNo
FX_Main_RecIDBetweenquerystring[]No
FX_Main_RecIDInquerystring[]No
CurrencyDecimalPlacesqueryshort?No
CurrencyDecimalPlacesGreaterThanOrEqualToqueryshort?No
CurrencyDecimalPlacesGreaterThanqueryshort?No
CurrencyDecimalPlacesLessThanqueryshort?No
CurrencyDecimalPlacesLessThanOrEqualToqueryshort?No
CurrencyDecimalPlacesNotEqualToqueryshort?No
CurrencyDecimalPlacesBetweenqueryNullable<Int16>[]No
CurrencyDecimalPlacesInqueryNullable<Int16>[]No
CurrencyRatequerydecimal?No
CurrencyRateGreaterThanOrEqualToquerydecimal?No
CurrencyRateGreaterThanquerydecimal?No
CurrencyRateLessThanquerydecimal?No
CurrencyRateLessThanOrEqualToquerydecimal?No
CurrencyRateNotEqualToquerydecimal?No
CurrencyRateBetweenqueryNullable<Decimal>[]No
CurrencyRateInqueryNullable<Decimal>[]No
FXAmountquerydecimal?No
FXAmountGreaterThanOrEqualToquerydecimal?No
FXAmountGreaterThanquerydecimal?No
FXAmountLessThanquerydecimal?No
FXAmountLessThanOrEqualToquerydecimal?No
FXAmountNotEqualToquerydecimal?No
FXAmountBetweenqueryNullable<Decimal>[]No
FXAmountInqueryNullable<Decimal>[]No
HomeAmountquerydecimal?No
HomeAmountGreaterThanOrEqualToquerydecimal?No
HomeAmountGreaterThanquerydecimal?No
HomeAmountLessThanquerydecimal?No
HomeAmountLessThanOrEqualToquerydecimal?No
HomeAmountNotEqualToquerydecimal?No
HomeAmountBetweenqueryNullable<Decimal>[]No
HomeAmountInqueryNullable<Decimal>[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
InitiatedDatequeryDateTime?No
InitiatedDateGreaterThanOrEqualToqueryDateTime?No
InitiatedDateGreaterThanqueryDateTime?No
InitiatedDateLessThanqueryDateTime?No
InitiatedDateLessThanOrEqualToqueryDateTime?No
InitiatedDateNotEqualToqueryDateTime?No
InitiatedDateBetweenqueryDateTime[]No
InitiatedDateInqueryDateTime[]No
StartDatequeryDateTime?No
StartDateGreaterThanOrEqualToqueryDateTime?No
StartDateGreaterThanqueryDateTime?No
StartDateLessThanqueryDateTime?No
StartDateLessThanOrEqualToqueryDateTime?No
StartDateNotEqualToqueryDateTime?No
StartDateBetweenqueryDateTime[]No
StartDateInqueryDateTime[]No
EndDatequeryDateTime?No
EndDateGreaterThanOrEqualToqueryDateTime?No
EndDateGreaterThanqueryDateTime?No
EndDateLessThanqueryDateTime?No
EndDateLessThanOrEqualToqueryDateTime?No
EndDateNotEqualToqueryDateTime?No
EndDateBetweenqueryDateTime[]No
EndDateInqueryDateTime[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenquerybyte[]No
StatusInquerybyte[]No
AutoCloseContractquerybyte?No
AutoCloseContractGreaterThanOrEqualToquerybyte?No
AutoCloseContractGreaterThanquerybyte?No
AutoCloseContractLessThanquerybyte?No
AutoCloseContractLessThanOrEqualToquerybyte?No
AutoCloseContractNotEqualToquerybyte?No
AutoCloseContractBetweenquerybyte[]No
AutoCloseContractInquerybyte[]No
HR_Staff_RecID_CreatedByquerystringNo
HR_Staff_RecID_CreatedByStartsWithquerystringNo
HR_Staff_RecID_CreatedByEndsWithquerystringNo
HR_Staff_RecID_CreatedByContainsquerystringNo
HR_Staff_RecID_CreatedByLikequerystringNo
HR_Staff_RecID_CreatedByBetweenquerystring[]No
HR_Staff_RecID_CreatedByInquerystring[]No
HR_Staff_RecID_LastSavedByquerystringNo
HR_Staff_RecID_LastSavedByStartsWithquerystringNo
HR_Staff_RecID_LastSavedByEndsWithquerystringNo
HR_Staff_RecID_LastSavedByContainsquerystringNo
HR_Staff_RecID_LastSavedByLikequerystringNo
HR_Staff_RecID_LastSavedByBetweenquerystring[]No
HR_Staff_RecID_LastSavedByInquerystring[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_ForwardCover Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
LastSavedDateTimeformDateTimeNo
ContractNoformstringNo
DescriptionformstringNo
FX_Main_RecIDformstringNo
CurrencyDecimalPlacesformshort?No
CurrencyRateformdecimal?No
FXAmountformdecimal?No
HomeAmountformdecimal?No
ReferenceformstringNo
InitiatedDateformDateTimeNo
StartDateformDateTimeNo
EndDateformDateTimeNo
StatusformbyteNo
AutoCloseContractformbyteNo
HR_Staff_RecID_CreatedByformstringNo
HR_Staff_RecID_LastSavedByformstringNo
RowHashformbyte[]No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/CR_ForwardCoverQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
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: text/csv
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"}}}