JiwaAPI

<back to all web services

SO_RunQuery

Requires Authentication
SO_RunQuery Parameters:
NameParameterData TypeRequiredDescription
RunIDquerystringNo
RunIDStartsWithquerystringNo
RunIDEndsWithquerystringNo
RunIDContainsquerystringNo
RunIDLikequerystringNo
RunIDBetweenquerystring[]No
RunIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
RunByquerystringNo
RunByStartsWithquerystringNo
RunByEndsWithquerystringNo
RunByContainsquerystringNo
RunByLikequerystringNo
RunByBetweenquerystring[]No
RunByInquerystring[]No
RunNoquerystringNo
RunNoStartsWithquerystringNo
RunNoEndsWithquerystringNo
RunNoContainsquerystringNo
RunNoLikequerystringNo
RunNoBetweenquerystring[]No
RunNoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_Run Parameters:
NameParameterData TypeRequiredDescription
RunIDformstringNo
LastSavedDateTimeformDateTimeNo
RunByformstringNo
RunNoformstringNo
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/SO_RunQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RunID":"String","RunIDStartsWith":"String","RunIDEndsWith":"String","RunIDContains":"String","RunIDLike":"String","RunIDBetween":["String"],"RunIDIn":["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"],"RunBy":"String","RunByStartsWith":"String","RunByEndsWith":"String","RunByContains":"String","RunByLike":"String","RunByBetween":["String"],"RunByIn":["String"],"RunNo":"String","RunNoStartsWith":"String","RunNoEndsWith":"String","RunNoContains":"String","RunNoLike":"String","RunNoBetween":["String"],"RunNoIn":["String"],"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":[{"RunID":"String","RunBy":"String","RunNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}