JiwaAPI

<back to all web services

JB_DocumentsQuery

Requires Authentication
JB_DocumentsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
JB_Main_RecIDquerystringNo
JB_Main_RecIDStartsWithquerystringNo
JB_Main_RecIDEndsWithquerystringNo
JB_Main_RecIDContainsquerystringNo
JB_Main_RecIDLikequerystringNo
JB_Main_RecIDBetweenquerystring[]No
JB_Main_RecIDInquerystring[]No
DocumentTypeIDquerystringNo
DocumentTypeIDStartsWithquerystringNo
DocumentTypeIDEndsWithquerystringNo
DocumentTypeIDContainsquerystringNo
DocumentTypeIDLikequerystringNo
DocumentTypeIDBetweenquerystring[]No
DocumentTypeIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
LastSavedByStaffIDquerystringNo
LastSavedByStaffIDStartsWithquerystringNo
LastSavedByStaffIDEndsWithquerystringNo
LastSavedByStaffIDContainsquerystringNo
LastSavedByStaffIDLikequerystringNo
LastSavedByStaffIDBetweenquerystring[]No
LastSavedByStaffIDInquerystring[]No
FileBinaryquerybyte[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
PhysicalFileNamequerystringNo
PhysicalFileNameStartsWithquerystringNo
PhysicalFileNameEndsWithquerystringNo
PhysicalFileNameContainsquerystringNo
PhysicalFileNameLikequerystringNo
PhysicalFileNameBetweenquerystring[]No
PhysicalFileNameInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_Documents Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
JB_Main_RecIDformstringNo
DocumentTypeIDformstringNo
LastSavedDateTimeformDateTime?No
LastSavedByStaffIDformstringNo
FileBinaryformbyte[]No
DescriptionformstringNo
PhysicalFileNameformstringNo
ItemNoformintNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/JB_DocumentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"JB_Main_RecID":"String","JB_Main_RecIDStartsWith":"String","JB_Main_RecIDEndsWith":"String","JB_Main_RecIDContains":"String","JB_Main_RecIDLike":"String","JB_Main_RecIDBetween":["String"],"JB_Main_RecIDIn":["String"],"DocumentTypeID":"String","DocumentTypeIDStartsWith":"String","DocumentTypeIDEndsWith":"String","DocumentTypeIDContains":"String","DocumentTypeIDLike":"String","DocumentTypeIDBetween":["String"],"DocumentTypeIDIn":["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"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["String"],"FileBinary":"AA==","Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"PhysicalFileName":"String","PhysicalFileNameStartsWith":"String","PhysicalFileNameEndsWith":"String","PhysicalFileNameContains":"String","PhysicalFileNameLike":"String","PhysicalFileNameBetween":["String"],"PhysicalFileNameIn":["String"],"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":[{"RecID":"String","JB_Main_RecID":"String","DocumentTypeID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedByStaffID":"String","FileBinary":"AA==","Description":"String","PhysicalFileName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}