JiwaAPI

<back to all web services

PO_BatchHeaderQuery

Requires Authentication
PO_BatchHeaderQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
CreatedByStaffIDquerystringNo
CreatedByStaffIDStartsWithquerystringNo
CreatedByStaffIDEndsWithquerystringNo
CreatedByStaffIDContainsquerystringNo
CreatedByStaffIDLikequerystringNo
CreatedByStaffIDBetweenquerystring[]No
CreatedByStaffIDInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryDateTime[]No
CreatedDateTimeInqueryDateTime[]No
LastModifiedByStaffIDquerystringNo
LastModifiedByStaffIDStartsWithquerystringNo
LastModifiedByStaffIDEndsWithquerystringNo
LastModifiedByStaffIDContainsquerystringNo
LastModifiedByStaffIDLikequerystringNo
LastModifiedByStaffIDBetweenquerystring[]No
LastModifiedByStaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
BatchStatusquerybyte?No
BatchStatusGreaterThanOrEqualToquerybyte?No
BatchStatusGreaterThanquerybyte?No
BatchStatusLessThanquerybyte?No
BatchStatusLessThanOrEqualToquerybyte?No
BatchStatusNotEqualToquerybyte?No
BatchStatusBetweenquerybyte[]No
BatchStatusInquerybyte[]No
ReOrderMonthquerybyte?No
ReOrderMonthGreaterThanOrEqualToquerybyte?No
ReOrderMonthGreaterThanquerybyte?No
ReOrderMonthLessThanquerybyte?No
ReOrderMonthLessThanOrEqualToquerybyte?No
ReOrderMonthNotEqualToquerybyte?No
ReOrderMonthBetweenquerybyte[]No
ReOrderMonthInquerybyte[]No
IncludeDefaultSuppliersOnlyquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PO_BatchHeader Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BatchNoformstringNo
IN_LogicalIDformstringNo
CreatedByStaffIDformstringNo
CreatedDateTimeformDateTimeNo
LastModifiedByStaffIDformstringNo
LastSavedDateTimeformDateTimeNo
BatchStatusformbyteNo
ReOrderMonthformbyteNo
IncludeDefaultSuppliersOnlyformboolNo
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/PO_BatchHeaderQuery 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"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"CreatedByStaffID":"String","CreatedByStaffIDStartsWith":"String","CreatedByStaffIDEndsWith":"String","CreatedByStaffIDContains":"String","CreatedByStaffIDLike":"String","CreatedByStaffIDBetween":["String"],"CreatedByStaffIDIn":["String"],"CreatedDateTime":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CreatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastModifiedByStaffID":"String","LastModifiedByStaffIDStartsWith":"String","LastModifiedByStaffIDEndsWith":"String","LastModifiedByStaffIDContains":"String","LastModifiedByStaffIDLike":"String","LastModifiedByStaffIDBetween":["String"],"LastModifiedByStaffIDIn":["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"],"BatchStatus":0,"BatchStatusGreaterThanOrEqualTo":0,"BatchStatusGreaterThan":0,"BatchStatusLessThan":0,"BatchStatusLessThanOrEqualTo":0,"BatchStatusNotEqualTo":0,"BatchStatusBetween":"AA==","BatchStatusIn":"AA==","ReOrderMonth":0,"ReOrderMonthGreaterThanOrEqualTo":0,"ReOrderMonthGreaterThan":0,"ReOrderMonthLessThan":0,"ReOrderMonthLessThanOrEqualTo":0,"ReOrderMonthNotEqualTo":0,"ReOrderMonthBetween":"AA==","ReOrderMonthIn":"AA==","IncludeDefaultSuppliersOnly":false,"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","BatchNo":"String","IN_LogicalID":"String","CreatedByStaffID":"String","LastModifiedByStaffID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}