JiwaAPI

<back to all web services

QO_ActivateBatchQuery

Requires Authentication
QO_ActivateBatchQuery Parameters:
NameParameterData TypeRequiredDescription
BatchIDquerystringNo
BatchIDStartsWithquerystringNo
BatchIDEndsWithquerystringNo
BatchIDContainsquerystringNo
BatchIDLikequerystringNo
BatchIDBetweenquerystring[]No
BatchIDInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
BatchDateTimequeryDateTime?No
BatchDateTimeGreaterThanOrEqualToqueryDateTime?No
BatchDateTimeGreaterThanqueryDateTime?No
BatchDateTimeLessThanqueryDateTime?No
BatchDateTimeLessThanOrEqualToqueryDateTime?No
BatchDateTimeNotEqualToqueryDateTime?No
BatchDateTimeBetweenqueryNullable<DateTime>[]No
BatchDateTimeInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
QO_ActivateBatch Parameters:
NameParameterData TypeRequiredDescription
BatchIDformstringNo
BatchNoformstringNo
BatchDateTimeformDateTime?No
StaffIDformstringNo
NotesformstringNo
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/QO_ActivateBatchQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BatchID":"String","BatchIDStartsWith":"String","BatchIDEndsWith":"String","BatchIDContains":"String","BatchIDLike":"String","BatchIDBetween":["String"],"BatchIDIn":["String"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"BatchDateTime":"0001-01-01T00:00:00.0000000","BatchDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","BatchDateTimeLessThan":"0001-01-01T00:00:00.0000000","BatchDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","BatchDateTimeBetween":["0001-01-01T00:00:00.0000000"],"BatchDateTimeIn":["0001-01-01T00:00:00.0000000"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["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":[{"BatchID":"String","BatchNo":"String","BatchDateTime":"0001-01-01T00:00:00.0000000","StaffID":"String","Notes":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}