JiwaAPI

<back to all web services

DB_DebtorSystemFieldValuesQuery

Requires Authentication
DB_DebtorSystemFieldValuesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
DB_DebtorSystemTemplateFields_RecIDquerystringNo
DB_DebtorSystemTemplateFields_RecIDStartsWithquerystringNo
DB_DebtorSystemTemplateFields_RecIDEndsWithquerystringNo
DB_DebtorSystemTemplateFields_RecIDContainsquerystringNo
DB_DebtorSystemTemplateFields_RecIDLikequerystringNo
DB_DebtorSystemTemplateFields_RecIDBetweenquerystring[]No
DB_DebtorSystemTemplateFields_RecIDInquerystring[]No
DB_DebtorSystems_RecIDquerystringNo
DB_DebtorSystems_RecIDStartsWithquerystringNo
DB_DebtorSystems_RecIDEndsWithquerystringNo
DB_DebtorSystems_RecIDContainsquerystringNo
DB_DebtorSystems_RecIDLikequerystringNo
DB_DebtorSystems_RecIDBetweenquerystring[]No
DB_DebtorSystems_RecIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
ContentsquerystringNo
ContentsStartsWithquerystringNo
ContentsEndsWithquerystringNo
ContentsContainsquerystringNo
ContentsLikequerystringNo
ContentsBetweenquerystring[]No
ContentsInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_DebtorSystemFieldValues Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
DB_DebtorSystemTemplateFields_RecIDformstringNo
DB_DebtorSystems_RecIDformstringNo
LastSavedDateTimeformDateTime?No
ContentsformstringNo
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/DB_DebtorSystemFieldValuesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"DB_DebtorSystemTemplateFields_RecID":"String","DB_DebtorSystemTemplateFields_RecIDStartsWith":"String","DB_DebtorSystemTemplateFields_RecIDEndsWith":"String","DB_DebtorSystemTemplateFields_RecIDContains":"String","DB_DebtorSystemTemplateFields_RecIDLike":"String","DB_DebtorSystemTemplateFields_RecIDBetween":["String"],"DB_DebtorSystemTemplateFields_RecIDIn":["String"],"DB_DebtorSystems_RecID":"String","DB_DebtorSystems_RecIDStartsWith":"String","DB_DebtorSystems_RecIDEndsWith":"String","DB_DebtorSystems_RecIDContains":"String","DB_DebtorSystems_RecIDLike":"String","DB_DebtorSystems_RecIDBetween":["String"],"DB_DebtorSystems_RecIDIn":["String"],"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"],"Contents":"String","ContentsStartsWith":"String","ContentsEndsWith":"String","ContentsContains":"String","ContentsLike":"String","ContentsBetween":["String"],"ContentsIn":["String"],"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":[{"RecID":"String","DB_DebtorSystemTemplateFields_RecID":"String","DB_DebtorSystems_RecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Contents":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}