| GET | /Queries/WebContacts | Queryable list of debtor contacts that have web properties, with their debtor (AutoQuery: Skip, Take, OrderBy, Fields, Include=Total and column filters). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DebtorID | query | string | No | |
| AccountNo | query | string | No | |
| ContactNameID | query | string | No | |
| WebUserId | query | string | No | |
| EmailAddress | query | string | No | |
| Mobile | query | string | No | |
| WebLastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| ContactLastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | 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 |
|---|---|---|---|---|
| DebtorID | form | string | No | |
| AccountNo | form | string | No | |
| DebtorName | form | string | No | |
| ContactNameID | form | string | No | |
| Title | form | string | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| EmailAddress | form | string | No | |
| Phone | form | string | No | |
| Mobile | form | string | No | |
| DefaultContact | form | bool? | No | |
| PrimaryPositionID | form | string | No | |
| WebUserId | form | string | No | |
| WebPermissions | form | string | No | |
| EmailMarketing | form | string | No | |
| ContactLastSavedDateTime | form | DateTime? | No | |
| WebLastSavedDateTime | form | DateTime? | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/WebContacts HTTP/1.1 Host: 10.150.151.12 Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"DebtorID":"String","AccountNo":"String","DebtorName":"String","ContactNameID":"String","Title":"String","FirstName":"String","Surname":"String","EmailAddress":"String","Phone":"String","Mobile":"String","DefaultContact":false,"PrimaryPositionID":"String","WebUserId":"String","WebPermissions":"String","EmailMarketing":"String","ContactLastSavedDateTime":"0001-01-01T00:00:00.0000000","WebLastSavedDateTime":"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"}}}