| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LinkID | query | string | No | |
| LinkIDStartsWith | query | string | No | |
| LinkIDEndsWith | query | string | No | |
| LinkIDContains | query | string | No | |
| LinkIDLike | query | string | No | |
| LinkIDBetween | query | string[] | No | |
| LinkIDIn | query | string[] | No | |
| GroupID | query | string | No | |
| GroupIDStartsWith | query | string | No | |
| GroupIDEndsWith | query | string | No | |
| GroupIDContains | query | string | No | |
| GroupIDLike | query | string | No | |
| GroupIDBetween | query | string[] | No | |
| GroupIDIn | 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 | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| DefaultItem | 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 | DateTime[] | No | |
| LastSavedDateTimeIn | query | 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 | Nullable<Int32>[] | No | |
| ItemNoIn | query | Nullable<Int32>[] | 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 |
|---|---|---|---|---|
| LinkID | form | string | No | |
| GroupID | form | string | No | |
| ProspectID | form | string | No | |
| StaffID | form | string | No | |
| DefaultItem | 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_GroupLinkQuery HTTP/1.1
Host: localhost
Accept: application/json
Content-Type: application/json
Content-Length: length
{"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"GroupID":"String","GroupIDStartsWith":"String","GroupIDEndsWith":"String","GroupIDContains":"String","GroupIDLike":"String","GroupIDBetween":["String"],"GroupIDIn":["String"],"ProspectID":"String","ProspectIDStartsWith":"String","ProspectIDEndsWith":"String","ProspectIDContains":"String","ProspectIDLike":"String","ProspectIDBetween":["String"],"ProspectIDIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"DefaultItem":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":[{"LinkID":"String","GroupID":"String","ProspectID":"String","StaffID":"String","ItemNo":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}