JiwaAPI

<back to all web services

BM_InstructionsQuery

Requires Authentication
BM_InstructionsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BM_Stages_RecIDquerystringNo
BM_Stages_RecIDStartsWithquerystringNo
BM_Stages_RecIDEndsWithquerystringNo
BM_Stages_RecIDContainsquerystringNo
BM_Stages_RecIDLikequerystringNo
BM_Stages_RecIDBetweenquerystring[]No
BM_Stages_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
InstructionTextquerystringNo
InstructionTextStartsWithquerystringNo
InstructionTextEndsWithquerystringNo
InstructionTextContainsquerystringNo
InstructionTextLikequerystringNo
InstructionTextBetweenquerystring[]No
InstructionTextInquerystring[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BM_Instructions Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BM_Stages_RecIDformstringNo
ItemNoformintNo
InstructionTextformstringNo
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 .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/BM_InstructionsQuery 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"],"BM_Stages_RecID":"String","BM_Stages_RecIDStartsWith":"String","BM_Stages_RecIDEndsWith":"String","BM_Stages_RecIDContains":"String","BM_Stages_RecIDLike":"String","BM_Stages_RecIDBetween":["String"],"BM_Stages_RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"InstructionText":"String","InstructionTextStartsWith":"String","InstructionTextEndsWith":"String","InstructionTextContains":"String","InstructionTextLike":"String","InstructionTextBetween":["String"],"InstructionTextIn":["String"],"RowHash":"AA==","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","BM_Stages_RecID":"String","InstructionText":"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"}}}