JiwaAPI

<back to all web services

BM_OutputsQuery

Requires Authentication
BM_OutputsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BM_Main_RecIDquerystringNo
BM_Main_RecIDStartsWithquerystringNo
BM_Main_RecIDEndsWithquerystringNo
BM_Main_RecIDContainsquerystringNo
BM_Main_RecIDLikequerystringNo
BM_Main_RecIDBetweenquerystring[]No
BM_Main_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
IsRatioquerybool?No
IsPrimaryquerybool?No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenquerydecimal[]No
QuantityInquerydecimal[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
CostPercentagequerydecimal?No
CostPercentageGreaterThanOrEqualToquerydecimal?No
CostPercentageGreaterThanquerydecimal?No
CostPercentageLessThanquerydecimal?No
CostPercentageLessThanOrEqualToquerydecimal?No
CostPercentageNotEqualToquerydecimal?No
CostPercentageBetweenquerydecimal[]No
CostPercentageInquerydecimal[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BM_Outputs Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BM_Main_RecIDformstringNo
ItemNoformintNo
InventoryIDformstringNo
IsRatioformboolNo
IsPrimaryformboolNo
QuantityformdecimalNo
NoteformstringNo
CostPercentageformdecimalNo
RowHashformbyte[]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.

POST /csv/reply/BM_OutputsQuery 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"],"BM_Main_RecID":"String","BM_Main_RecIDStartsWith":"String","BM_Main_RecIDEndsWith":"String","BM_Main_RecIDContains":"String","BM_Main_RecIDLike":"String","BM_Main_RecIDBetween":["String"],"BM_Main_RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"IsRatio":false,"IsPrimary":false,"Quantity":0,"QuantityGreaterThanOrEqualTo":0,"QuantityGreaterThan":0,"QuantityLessThan":0,"QuantityLessThanOrEqualTo":0,"QuantityNotEqualTo":0,"QuantityBetween":[0],"QuantityIn":[0],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"CostPercentage":0,"CostPercentageGreaterThanOrEqualTo":0,"CostPercentageGreaterThan":0,"CostPercentageLessThan":0,"CostPercentageLessThanOrEqualTo":0,"CostPercentageNotEqualTo":0,"CostPercentageBetween":[0],"CostPercentageIn":[0],"RowHash":"AA==","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","BM_Main_RecID":"String","InventoryID":"String","Note":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}