JiwaAPI

<back to all web services

CN_ContactQuery

Requires Authentication
CN_ContactQuery Parameters:
NameParameterData TypeRequiredDescription
ContactIDquerystringNo
ContactIDStartsWithquerystringNo
ContactIDEndsWithquerystringNo
ContactIDContainsquerystringNo
ContactIDLikequerystringNo
ContactIDBetweenquerystring[]No
ContactIDInquerystring[]No
AccNoquerystringNo
AccNoStartsWithquerystringNo
AccNoEndsWithquerystringNo
AccNoContainsquerystringNo
AccNoLikequerystringNo
AccNoBetweenquerystring[]No
AccNoInquerystring[]No
TitlequerystringNo
TitleStartsWithquerystringNo
TitleEndsWithquerystringNo
TitleContainsquerystringNo
TitleLikequerystringNo
TitleBetweenquerystring[]No
TitleInquerystring[]No
FNamequerystringNo
FNameStartsWithquerystringNo
FNameEndsWithquerystringNo
FNameContainsquerystringNo
FNameLikequerystringNo
FNameBetweenquerystring[]No
FNameInquerystring[]No
SNamequerystringNo
SNameStartsWithquerystringNo
SNameEndsWithquerystringNo
SNameContainsquerystringNo
SNameLikequerystringNo
SNameBetweenquerystring[]No
SNameInquerystring[]No
PrimaryIDquerystringNo
PrimaryIDStartsWithquerystringNo
PrimaryIDEndsWithquerystringNo
PrimaryIDContainsquerystringNo
PrimaryIDLikequerystringNo
PrimaryIDBetweenquerystring[]No
PrimaryIDInquerystring[]No
SecondaryIDquerystringNo
SecondaryIDStartsWithquerystringNo
SecondaryIDEndsWithquerystringNo
SecondaryIDContainsquerystringNo
SecondaryIDLikequerystringNo
SecondaryIDBetweenquerystring[]No
SecondaryIDInquerystring[]No
TertiaryIDquerystringNo
TertiaryIDStartsWithquerystringNo
TertiaryIDEndsWithquerystringNo
TertiaryIDContainsquerystringNo
TertiaryIDLikequerystringNo
TertiaryIDBetweenquerystring[]No
TertiaryIDInquerystring[]No
PhonequerystringNo
PhoneStartsWithquerystringNo
PhoneEndsWithquerystringNo
PhoneContainsquerystringNo
PhoneLikequerystringNo
PhoneBetweenquerystring[]No
PhoneInquerystring[]No
MobilequerystringNo
MobileStartsWithquerystringNo
MobileEndsWithquerystringNo
MobileContainsquerystringNo
MobileLikequerystringNo
MobileBetweenquerystring[]No
MobileInquerystring[]No
FaxquerystringNo
FaxStartsWithquerystringNo
FaxEndsWithquerystringNo
FaxContainsquerystringNo
FaxLikequerystringNo
FaxBetweenquerystring[]No
FaxInquerystring[]No
EmailAddressquerystringNo
EmailAddressStartsWithquerystringNo
EmailAddressEndsWithquerystringNo
EmailAddressContainsquerystringNo
EmailAddressLikequerystringNo
EmailAddressBetweenquerystring[]No
EmailAddressInquerystring[]No
ProspectIDquerystringNo
ProspectIDStartsWithquerystringNo
ProspectIDEndsWithquerystringNo
ProspectIDContainsquerystringNo
ProspectIDLikequerystringNo
ProspectIDBetweenquerystring[]No
ProspectIDInquerystring[]No
LogonCodequerystringNo
LogonCodeStartsWithquerystringNo
LogonCodeEndsWithquerystringNo
LogonCodeContainsquerystringNo
LogonCodeLikequerystringNo
LogonCodeBetweenquerystring[]No
LogonCodeInquerystring[]No
LogonPasswordquerystringNo
LogonPasswordStartsWithquerystringNo
LogonPasswordEndsWithquerystringNo
LogonPasswordContainsquerystringNo
LogonPasswordLikequerystringNo
LogonPasswordBetweenquerystring[]No
LogonPasswordInquerystring[]No
ExternalAppRecIDquerystringNo
ExternalAppRecIDStartsWithquerystringNo
ExternalAppRecIDEndsWithquerystringNo
ExternalAppRecIDContainsquerystringNo
ExternalAppRecIDLikequerystringNo
ExternalAppRecIDBetweenquerystring[]No
ExternalAppRecIDInquerystring[]No
DefaultContactquerybool?No
DebtorContactquerybool?No
CreditorContactquerybool?No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CN_Contact Parameters:
NameParameterData TypeRequiredDescription
ContactIDformstringNo
AccNoformstringNo
TitleformstringNo
FNameformstringNo
SNameformstringNo
PrimaryIDformstringNo
SecondaryIDformstringNo
TertiaryIDformstringNo
PhoneformstringNo
MobileformstringNo
FaxformstringNo
EmailAddressformstringNo
ProspectIDformstringNo
LogonCodeformstringNo
LogonPasswordformstringNo
ExternalAppRecIDformstringNo
DefaultContactformbool?No
DebtorContactformbool?No
CreditorContactformbool?No
LastSavedDateTimeformDateTime?No
ItemNoformintNo
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/CN_ContactQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactID":"String","ContactIDStartsWith":"String","ContactIDEndsWith":"String","ContactIDContains":"String","ContactIDLike":"String","ContactIDBetween":["String"],"ContactIDIn":["String"],"AccNo":"String","AccNoStartsWith":"String","AccNoEndsWith":"String","AccNoContains":"String","AccNoLike":"String","AccNoBetween":["String"],"AccNoIn":["String"],"Title":"String","TitleStartsWith":"String","TitleEndsWith":"String","TitleContains":"String","TitleLike":"String","TitleBetween":["String"],"TitleIn":["String"],"FName":"String","FNameStartsWith":"String","FNameEndsWith":"String","FNameContains":"String","FNameLike":"String","FNameBetween":["String"],"FNameIn":["String"],"SName":"String","SNameStartsWith":"String","SNameEndsWith":"String","SNameContains":"String","SNameLike":"String","SNameBetween":["String"],"SNameIn":["String"],"PrimaryID":"String","PrimaryIDStartsWith":"String","PrimaryIDEndsWith":"String","PrimaryIDContains":"String","PrimaryIDLike":"String","PrimaryIDBetween":["String"],"PrimaryIDIn":["String"],"SecondaryID":"String","SecondaryIDStartsWith":"String","SecondaryIDEndsWith":"String","SecondaryIDContains":"String","SecondaryIDLike":"String","SecondaryIDBetween":["String"],"SecondaryIDIn":["String"],"TertiaryID":"String","TertiaryIDStartsWith":"String","TertiaryIDEndsWith":"String","TertiaryIDContains":"String","TertiaryIDLike":"String","TertiaryIDBetween":["String"],"TertiaryIDIn":["String"],"Phone":"String","PhoneStartsWith":"String","PhoneEndsWith":"String","PhoneContains":"String","PhoneLike":"String","PhoneBetween":["String"],"PhoneIn":["String"],"Mobile":"String","MobileStartsWith":"String","MobileEndsWith":"String","MobileContains":"String","MobileLike":"String","MobileBetween":["String"],"MobileIn":["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"],"ProspectID":"String","ProspectIDStartsWith":"String","ProspectIDEndsWith":"String","ProspectIDContains":"String","ProspectIDLike":"String","ProspectIDBetween":["String"],"ProspectIDIn":["String"],"LogonCode":"String","LogonCodeStartsWith":"String","LogonCodeEndsWith":"String","LogonCodeContains":"String","LogonCodeLike":"String","LogonCodeBetween":["String"],"LogonCodeIn":["String"],"LogonPassword":"String","LogonPasswordStartsWith":"String","LogonPasswordEndsWith":"String","LogonPasswordContains":"String","LogonPasswordLike":"String","LogonPasswordBetween":["String"],"LogonPasswordIn":["String"],"ExternalAppRecID":"String","ExternalAppRecIDStartsWith":"String","ExternalAppRecIDEndsWith":"String","ExternalAppRecIDContains":"String","ExternalAppRecIDLike":"String","ExternalAppRecIDBetween":["String"],"ExternalAppRecIDIn":["String"],"DefaultContact":false,"DebtorContact":false,"CreditorContact":false,"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"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"ContactID":"String","AccNo":"String","Title":"String","FName":"String","SName":"String","PrimaryID":"String","SecondaryID":"String","TertiaryID":"String","Phone":"String","Mobile":"String","Fax":"String","EmailAddress":"String","ProspectID":"String","LogonCode":"String","LogonPassword":"String","ExternalAppRecID":"String","DefaultContact":false,"DebtorContact":false,"CreditorContact":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}