JiwaAPI

<back to all web services

WebContactsQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/WebContactsQueryable list of debtor contacts that have web properties, with their debtor (AutoQuery: Skip, Take, OrderBy, Fields, Include=Total and column filters).
WebContactsQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
AccountNoquerystringNo
ContactNameIDquerystringNo
WebUserIdquerystringNo
EmailAddressquerystringNo
MobilequerystringNo
WebLastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
ContactLastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_TFM_WebContacts Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
AccountNoformstringNo
DebtorNameformstringNo
ContactNameIDformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
EmailAddressformstringNo
PhoneformstringNo
MobileformstringNo
DefaultContactformbool?No
PrimaryPositionIDformstringNo
WebUserIdformstringNo
WebPermissionsformstringNo
EmailMarketingformstringNo
ContactLastSavedDateTimeformDateTime?No
WebLastSavedDateTimeformDateTime?No
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.

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"}}}