JiwaAPI

<back to all web services

CN_MainQuery

Requires Authentication
CN_MainQuery Parameters:
NameParameterData TypeRequiredDescription
ProspectIDquerystringNo
ProspectIDStartsWithquerystringNo
ProspectIDEndsWithquerystringNo
ProspectIDContainsquerystringNo
ProspectIDLikequerystringNo
ProspectIDBetweenquerystring[]No
ProspectIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
ProspectNumberquerystringNo
ProspectNumberStartsWithquerystringNo
ProspectNumberEndsWithquerystringNo
ProspectNumberContainsquerystringNo
ProspectNumberLikequerystringNo
ProspectNumberBetweenquerystring[]No
ProspectNumberInquerystring[]No
CompanyNamequerystringNo
CompanyNameStartsWithquerystringNo
CompanyNameEndsWithquerystringNo
CompanyNameContainsquerystringNo
CompanyNameLikequerystringNo
CompanyNameBetweenquerystring[]No
CompanyNameInquerystring[]No
Address1querystringNo
Address1StartsWithquerystringNo
Address1EndsWithquerystringNo
Address1ContainsquerystringNo
Address1LikequerystringNo
Address1Betweenquerystring[]No
Address1Inquerystring[]No
Address2querystringNo
Address2StartsWithquerystringNo
Address2EndsWithquerystringNo
Address2ContainsquerystringNo
Address2LikequerystringNo
Address2Betweenquerystring[]No
Address2Inquerystring[]No
Address3querystringNo
Address3StartsWithquerystringNo
Address3EndsWithquerystringNo
Address3ContainsquerystringNo
Address3LikequerystringNo
Address3Betweenquerystring[]No
Address3Inquerystring[]No
StatequerystringNo
StateStartsWithquerystringNo
StateEndsWithquerystringNo
StateContainsquerystringNo
StateLikequerystringNo
StateBetweenquerystring[]No
StateInquerystring[]No
PostCodequerystringNo
PostCodeStartsWithquerystringNo
PostCodeEndsWithquerystringNo
PostCodeContainsquerystringNo
PostCodeLikequerystringNo
PostCodeBetweenquerystring[]No
PostCodeInquerystring[]No
PhonequerystringNo
PhoneStartsWithquerystringNo
PhoneEndsWithquerystringNo
PhoneContainsquerystringNo
PhoneLikequerystringNo
PhoneBetweenquerystring[]No
PhoneInquerystring[]No
FaxquerystringNo
FaxStartsWithquerystringNo
FaxEndsWithquerystringNo
FaxContainsquerystringNo
FaxLikequerystringNo
FaxBetweenquerystring[]No
FaxInquerystring[]No
EmailAddressquerystringNo
EmailAddressStartsWithquerystringNo
EmailAddressEndsWithquerystringNo
EmailAddressContainsquerystringNo
EmailAddressLikequerystringNo
EmailAddressBetweenquerystring[]No
EmailAddressInquerystring[]No
CRAccountNoquerystringNo
CRAccountNoStartsWithquerystringNo
CRAccountNoEndsWithquerystringNo
CRAccountNoContainsquerystringNo
CRAccountNoLikequerystringNo
CRAccountNoBetweenquerystring[]No
CRAccountNoInquerystring[]No
DBAccountNoquerystringNo
DBAccountNoStartsWithquerystringNo
DBAccountNoEndsWithquerystringNo
DBAccountNoContainsquerystringNo
DBAccountNoLikequerystringNo
DBAccountNoBetweenquerystring[]No
DBAccountNoInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
ExternalAppRecIDquerystringNo
ExternalAppRecIDStartsWithquerystringNo
ExternalAppRecIDEndsWithquerystringNo
ExternalAppRecIDContainsquerystringNo
ExternalAppRecIDLikequerystringNo
ExternalAppRecIDBetweenquerystring[]No
ExternalAppRecIDInquerystring[]No
AustPostDPIDquerystringNo
AustPostDPIDStartsWithquerystringNo
AustPostDPIDEndsWithquerystringNo
AustPostDPIDContainsquerystringNo
AustPostDPIDLikequerystringNo
AustPostDPIDBetweenquerystring[]No
AustPostDPIDInquerystring[]No
AustPostBCSPquerystringNo
AustPostBCSPStartsWithquerystringNo
AustPostBCSPEndsWithquerystringNo
AustPostBCSPContainsquerystringNo
AustPostBCSPLikequerystringNo
AustPostBCSPBetweenquerystring[]No
AustPostBCSPInquerystring[]No
CountryquerystringNo
CountryStartsWithquerystringNo
CountryEndsWithquerystringNo
CountryContainsquerystringNo
CountryLikequerystringNo
CountryBetweenquerystring[]No
CountryInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CN_Main Parameters:
NameParameterData TypeRequiredDescription
ProspectIDformstringNo
LastSavedDateTimeformDateTime?No
ProspectNumberformstringNo
CompanyNameformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
StateformstringNo
PostCodeformstringNo
PhoneformstringNo
FaxformstringNo
EmailAddressformstringNo
CRAccountNoformstringNo
DBAccountNoformstringNo
CreditorIDformstringNo
DebtorIDformstringNo
ExternalAppRecIDformstringNo
AustPostDPIDformstringNo
AustPostBCSPformstringNo
CountryformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/CN_MainQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProspectID":"String","ProspectIDStartsWith":"String","ProspectIDEndsWith":"String","ProspectIDContains":"String","ProspectIDLike":"String","ProspectIDBetween":["String"],"ProspectIDIn":["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"],"ProspectNumber":"String","ProspectNumberStartsWith":"String","ProspectNumberEndsWith":"String","ProspectNumberContains":"String","ProspectNumberLike":"String","ProspectNumberBetween":["String"],"ProspectNumberIn":["String"],"CompanyName":"String","CompanyNameStartsWith":"String","CompanyNameEndsWith":"String","CompanyNameContains":"String","CompanyNameLike":"String","CompanyNameBetween":["String"],"CompanyNameIn":["String"],"Address1":"String","Address1StartsWith":"String","Address1EndsWith":"String","Address1Contains":"String","Address1Like":"String","Address1Between":["String"],"Address1In":["String"],"Address2":"String","Address2StartsWith":"String","Address2EndsWith":"String","Address2Contains":"String","Address2Like":"String","Address2Between":["String"],"Address2In":["String"],"Address3":"String","Address3StartsWith":"String","Address3EndsWith":"String","Address3Contains":"String","Address3Like":"String","Address3Between":["String"],"Address3In":["String"],"State":"String","StateStartsWith":"String","StateEndsWith":"String","StateContains":"String","StateLike":"String","StateBetween":["String"],"StateIn":["String"],"PostCode":"String","PostCodeStartsWith":"String","PostCodeEndsWith":"String","PostCodeContains":"String","PostCodeLike":"String","PostCodeBetween":["String"],"PostCodeIn":["String"],"Phone":"String","PhoneStartsWith":"String","PhoneEndsWith":"String","PhoneContains":"String","PhoneLike":"String","PhoneBetween":["String"],"PhoneIn":["String"],"Fax":"String","FaxStartsWith":"String","FaxEndsWith":"String","FaxContains":"String","FaxLike":"String","FaxBetween":["String"],"FaxIn":["String"],"EmailAddress":"String","EmailAddressStartsWith":"String","EmailAddressEndsWith":"String","EmailAddressContains":"String","EmailAddressLike":"String","EmailAddressBetween":["String"],"EmailAddressIn":["String"],"CRAccountNo":"String","CRAccountNoStartsWith":"String","CRAccountNoEndsWith":"String","CRAccountNoContains":"String","CRAccountNoLike":"String","CRAccountNoBetween":["String"],"CRAccountNoIn":["String"],"DBAccountNo":"String","DBAccountNoStartsWith":"String","DBAccountNoEndsWith":"String","DBAccountNoContains":"String","DBAccountNoLike":"String","DBAccountNoBetween":["String"],"DBAccountNoIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"ExternalAppRecID":"String","ExternalAppRecIDStartsWith":"String","ExternalAppRecIDEndsWith":"String","ExternalAppRecIDContains":"String","ExternalAppRecIDLike":"String","ExternalAppRecIDBetween":["String"],"ExternalAppRecIDIn":["String"],"AustPostDPID":"String","AustPostDPIDStartsWith":"String","AustPostDPIDEndsWith":"String","AustPostDPIDContains":"String","AustPostDPIDLike":"String","AustPostDPIDBetween":["String"],"AustPostDPIDIn":["String"],"AustPostBCSP":"String","AustPostBCSPStartsWith":"String","AustPostBCSPEndsWith":"String","AustPostBCSPContains":"String","AustPostBCSPLike":"String","AustPostBCSPBetween":["String"],"AustPostBCSPIn":["String"],"Country":"String","CountryStartsWith":"String","CountryEndsWith":"String","CountryContains":"String","CountryLike":"String","CountryBetween":["String"],"CountryIn":["String"],"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":[{"ProspectID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ProspectNumber":"String","CompanyName":"String","Address1":"String","Address2":"String","Address3":"String","State":"String","PostCode":"String","Phone":"String","Fax":"String","EmailAddress":"String","CRAccountNo":"String","DBAccountNo":"String","CreditorID":"String","DebtorID":"String","ExternalAppRecID":"String","AustPostDPID":"String","AustPostBCSP":"String","Country":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}