JiwaAPI

<back to all web services

RA_DocumentsQuery

Requires Authentication
RA_DocumentsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
FileIDquerystringNo
FileIDStartsWithquerystringNo
FileIDEndsWithquerystringNo
FileIDContainsquerystringNo
FileIDLikequerystringNo
FileIDBetweenquerystring[]No
FileIDInquerystring[]No
ParentIDquerystringNo
ParentIDStartsWithquerystringNo
ParentIDEndsWithquerystringNo
ParentIDContainsquerystringNo
ParentIDLikequerystringNo
ParentIDBetweenquerystring[]No
ParentIDInquerystring[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
UserNamequerystringNo
UserNameStartsWithquerystringNo
UserNameEndsWithquerystringNo
UserNameContainsquerystringNo
UserNameLikequerystringNo
UserNameBetweenquerystring[]No
UserNameInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DocTypeIDquerystringNo
DocTypeIDStartsWithquerystringNo
DocTypeIDEndsWithquerystringNo
DocTypeIDContainsquerystringNo
DocTypeIDLikequerystringNo
DocTypeIDBetweenquerystring[]No
DocTypeIDInquerystring[]No
ParentTypequeryshort?No
ParentTypeGreaterThanOrEqualToqueryshort?No
ParentTypeGreaterThanqueryshort?No
ParentTypeLessThanqueryshort?No
ParentTypeLessThanOrEqualToqueryshort?No
ParentTypeNotEqualToqueryshort?No
ParentTypeBetweenqueryshort[]No
ParentTypeInqueryshort[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
RA_Documents Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
FileIDformstringNo
ParentIDformstringNo
RemarkformstringNo
UserNameformstringNo
LastSavedDateTimeformDateTime?No
DocTypeIDformstringNo
ParentTypeformshortNo
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/RA_DocumentsQuery 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"],"FileID":"String","FileIDStartsWith":"String","FileIDEndsWith":"String","FileIDContains":"String","FileIDLike":"String","FileIDBetween":["String"],"FileIDIn":["String"],"ParentID":"String","ParentIDStartsWith":"String","ParentIDEndsWith":"String","ParentIDContains":"String","ParentIDLike":"String","ParentIDBetween":["String"],"ParentIDIn":["String"],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"UserName":"String","UserNameStartsWith":"String","UserNameEndsWith":"String","UserNameContains":"String","UserNameLike":"String","UserNameBetween":["String"],"UserNameIn":["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"],"DocTypeID":"String","DocTypeIDStartsWith":"String","DocTypeIDEndsWith":"String","DocTypeIDContains":"String","DocTypeIDLike":"String","DocTypeIDBetween":["String"],"DocTypeIDIn":["String"],"ParentType":0,"ParentTypeGreaterThanOrEqualTo":0,"ParentTypeGreaterThan":0,"ParentTypeLessThan":0,"ParentTypeLessThanOrEqualTo":0,"ParentTypeNotEqualTo":0,"ParentTypeBetween":[0],"ParentTypeIn":[0],"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","FileID":"String","ParentID":"String","Remark":"String","UserName":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","DocTypeID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}