| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactID | query | string | No | |
| ContactIDStartsWith | query | string | No | |
| ContactIDEndsWith | query | string | No | |
| ContactIDContains | query | string | No | |
| ContactIDLike | query | string | No | |
| ContactIDBetween | query | string[] | No | |
| ContactIDIn | query | string[] | No | |
| AccNo | query | string | No | |
| AccNoStartsWith | query | string | No | |
| AccNoEndsWith | query | string | No | |
| AccNoContains | query | string | No | |
| AccNoLike | query | string | No | |
| AccNoBetween | query | string[] | No | |
| AccNoIn | query | string[] | No | |
| Title | query | string | No | |
| TitleStartsWith | query | string | No | |
| TitleEndsWith | query | string | No | |
| TitleContains | query | string | No | |
| TitleLike | query | string | No | |
| TitleBetween | query | string[] | No | |
| TitleIn | query | string[] | No | |
| FName | query | string | No | |
| FNameStartsWith | query | string | No | |
| FNameEndsWith | query | string | No | |
| FNameContains | query | string | No | |
| FNameLike | query | string | No | |
| FNameBetween | query | string[] | No | |
| FNameIn | query | string[] | No | |
| SName | query | string | No | |
| SNameStartsWith | query | string | No | |
| SNameEndsWith | query | string | No | |
| SNameContains | query | string | No | |
| SNameLike | query | string | No | |
| SNameBetween | query | string[] | No | |
| SNameIn | query | string[] | No | |
| PrimaryID | query | string | No | |
| PrimaryIDStartsWith | query | string | No | |
| PrimaryIDEndsWith | query | string | No | |
| PrimaryIDContains | query | string | No | |
| PrimaryIDLike | query | string | No | |
| PrimaryIDBetween | query | string[] | No | |
| PrimaryIDIn | query | string[] | No | |
| SecondaryID | query | string | No | |
| SecondaryIDStartsWith | query | string | No | |
| SecondaryIDEndsWith | query | string | No | |
| SecondaryIDContains | query | string | No | |
| SecondaryIDLike | query | string | No | |
| SecondaryIDBetween | query | string[] | No | |
| SecondaryIDIn | query | string[] | No | |
| TertiaryID | query | string | No | |
| TertiaryIDStartsWith | query | string | No | |
| TertiaryIDEndsWith | query | string | No | |
| TertiaryIDContains | query | string | No | |
| TertiaryIDLike | query | string | No | |
| TertiaryIDBetween | query | string[] | No | |
| TertiaryIDIn | query | string[] | No | |
| Phone | query | string | No | |
| PhoneStartsWith | query | string | No | |
| PhoneEndsWith | query | string | No | |
| PhoneContains | query | string | No | |
| PhoneLike | query | string | No | |
| PhoneBetween | query | string[] | No | |
| PhoneIn | query | string[] | No | |
| Mobile | query | string | No | |
| MobileStartsWith | query | string | No | |
| MobileEndsWith | query | string | No | |
| MobileContains | query | string | No | |
| MobileLike | query | string | No | |
| MobileBetween | query | string[] | No | |
| MobileIn | query | string[] | No | |
| Fax | query | string | No | |
| FaxStartsWith | query | string | No | |
| FaxEndsWith | query | string | No | |
| FaxContains | query | string | No | |
| FaxLike | query | string | No | |
| FaxBetween | query | string[] | No | |
| FaxIn | query | string[] | No | |
| EmailAddress | query | string | No | |
| EmailAddressStartsWith | query | string | No | |
| EmailAddressEndsWith | query | string | No | |
| EmailAddressContains | query | string | No | |
| EmailAddressLike | query | string | No | |
| EmailAddressBetween | query | string[] | No | |
| EmailAddressIn | query | string[] | No | |
| ProspectID | query | string | No | |
| ProspectIDStartsWith | query | string | No | |
| ProspectIDEndsWith | query | string | No | |
| ProspectIDContains | query | string | No | |
| ProspectIDLike | query | string | No | |
| ProspectIDBetween | query | string[] | No | |
| ProspectIDIn | query | string[] | No | |
| LogonCode | query | string | No | |
| LogonCodeStartsWith | query | string | No | |
| LogonCodeEndsWith | query | string | No | |
| LogonCodeContains | query | string | No | |
| LogonCodeLike | query | string | No | |
| LogonCodeBetween | query | string[] | No | |
| LogonCodeIn | query | string[] | No | |
| LogonPassword | query | string | No | |
| LogonPasswordStartsWith | query | string | No | |
| LogonPasswordEndsWith | query | string | No | |
| LogonPasswordContains | query | string | No | |
| LogonPasswordLike | query | string | No | |
| LogonPasswordBetween | query | string[] | No | |
| LogonPasswordIn | query | string[] | No | |
| ExternalAppRecID | query | string | No | |
| ExternalAppRecIDStartsWith | query | string | No | |
| ExternalAppRecIDEndsWith | query | string | No | |
| ExternalAppRecIDContains | query | string | No | |
| ExternalAppRecIDLike | query | string | No | |
| ExternalAppRecIDBetween | query | string[] | No | |
| ExternalAppRecIDIn | query | string[] | No | |
| DefaultContact | query | bool? | No | |
| DebtorContact | query | bool? | No | |
| CreditorContact | query | bool? | 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 | Nullable<DateTime>[] | No | |
| LastSavedDateTimeIn | query | Nullable<DateTime>[] | 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 |
| 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 |
|---|---|---|---|---|
| ContactID | form | string | No | |
| AccNo | form | string | No | |
| Title | form | string | No | |
| FName | form | string | No | |
| SName | form | string | No | |
| PrimaryID | form | string | No | |
| SecondaryID | form | string | No | |
| TertiaryID | form | string | No | |
| Phone | form | string | No | |
| Mobile | form | string | No | |
| Fax | form | string | No | |
| EmailAddress | form | string | No | |
| ProspectID | form | string | No | |
| LogonCode | form | string | No | |
| LogonPassword | form | string | No | |
| ExternalAppRecID | form | string | No | |
| DefaultContact | form | bool? | No | |
| DebtorContact | form | bool? | No | |
| CreditorContact | form | bool? | No | |
| LastSavedDateTime | form | DateTime? | No | |
| ItemNo | form | int | 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/CN_ContactQuery HTTP/1.1
Host: localhost
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}