JiwaAPI

<back to all web services

JB_ResourcesQuery

Requires Authentication
JB_ResourcesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
RecNumquerystringNo
RecNumStartsWithquerystringNo
RecNumEndsWithquerystringNo
RecNumContainsquerystringNo
RecNumLikequerystringNo
RecNumBetweenquerystring[]No
RecNumInquerystring[]No
RecDescriptionquerystringNo
RecDescriptionStartsWithquerystringNo
RecDescriptionEndsWithquerystringNo
RecDescriptionContainsquerystringNo
RecDescriptionLikequerystringNo
RecDescriptionBetweenquerystring[]No
RecDescriptionInquerystring[]No
RecTypequeryshort?No
RecTypeGreaterThanOrEqualToqueryshort?No
RecTypeGreaterThanqueryshort?No
RecTypeLessThanqueryshort?No
RecTypeLessThanOrEqualToqueryshort?No
RecTypeNotEqualToqueryshort?No
RecTypeBetweenqueryNullable<Int16>[]No
RecTypeInqueryNullable<Int16>[]No
RecGroupquerystringNo
RecGroupStartsWithquerystringNo
RecGroupEndsWithquerystringNo
RecGroupContainsquerystringNo
RecGroupLikequerystringNo
RecGroupBetweenquerystring[]No
RecGroupInquerystring[]No
Costquerydecimal?No
CostGreaterThanOrEqualToquerydecimal?No
CostGreaterThanquerydecimal?No
CostLessThanquerydecimal?No
CostLessThanOrEqualToquerydecimal?No
CostNotEqualToquerydecimal?No
CostBetweenqueryNullable<Decimal>[]No
CostInqueryNullable<Decimal>[]No
Chargequerydecimal?No
ChargeGreaterThanOrEqualToquerydecimal?No
ChargeGreaterThanquerydecimal?No
ChargeLessThanquerydecimal?No
ChargeLessThanOrEqualToquerydecimal?No
ChargeNotEqualToquerydecimal?No
ChargeBetweenqueryNullable<Decimal>[]No
ChargeInqueryNullable<Decimal>[]No
UnitquerystringNo
UnitStartsWithquerystringNo
UnitEndsWithquerystringNo
UnitContainsquerystringNo
UnitLikequerystringNo
UnitBetweenquerystring[]No
UnitInquerystring[]No
Statusquerybool?No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
GLCodequerystringNo
GLCodeStartsWithquerystringNo
GLCodeEndsWithquerystringNo
GLCodeContainsquerystringNo
GLCodeLikequerystringNo
GLCodeBetweenquerystring[]No
GLCodeInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_Resources Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
RecNumformstringNo
RecDescriptionformstringNo
RecTypeformshort?No
RecGroupformstringNo
Costformdecimal?No
Chargeformdecimal?No
UnitformstringNo
Statusformbool?No
NoteformstringNo
LastSavedDateTimeformDateTimeNo
GLCodeformstringNo
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_ResourcesQuery 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"],"RecNum":"String","RecNumStartsWith":"String","RecNumEndsWith":"String","RecNumContains":"String","RecNumLike":"String","RecNumBetween":["String"],"RecNumIn":["String"],"RecDescription":"String","RecDescriptionStartsWith":"String","RecDescriptionEndsWith":"String","RecDescriptionContains":"String","RecDescriptionLike":"String","RecDescriptionBetween":["String"],"RecDescriptionIn":["String"],"RecType":0,"RecTypeGreaterThanOrEqualTo":0,"RecTypeGreaterThan":0,"RecTypeLessThan":0,"RecTypeLessThanOrEqualTo":0,"RecTypeNotEqualTo":0,"RecTypeBetween":[0],"RecTypeIn":[0],"RecGroup":"String","RecGroupStartsWith":"String","RecGroupEndsWith":"String","RecGroupContains":"String","RecGroupLike":"String","RecGroupBetween":["String"],"RecGroupIn":["String"],"Cost":0,"CostGreaterThanOrEqualTo":0,"CostGreaterThan":0,"CostLessThan":0,"CostLessThanOrEqualTo":0,"CostNotEqualTo":0,"CostBetween":[0],"CostIn":[0],"Charge":0,"ChargeGreaterThanOrEqualTo":0,"ChargeGreaterThan":0,"ChargeLessThan":0,"ChargeLessThanOrEqualTo":0,"ChargeNotEqualTo":0,"ChargeBetween":[0],"ChargeIn":[0],"Unit":"String","UnitStartsWith":"String","UnitEndsWith":"String","UnitContains":"String","UnitLike":"String","UnitBetween":["String"],"UnitIn":["String"],"Status":false,"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["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"],"GLCode":"String","GLCodeStartsWith":"String","GLCodeEndsWith":"String","GLCodeContains":"String","GLCodeLike":"String","GLCodeBetween":["String"],"GLCodeIn":["String"],"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","RecNum":"String","RecDescription":"String","RecType":0,"RecGroup":"String","Cost":0,"Charge":0,"Unit":"String","Status":false,"Note":"String","GLCode":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}