JiwaAPI

<back to all web services

SO_ExportMainQuery

Requires Authentication
SO_ExportMainQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
DateCreatedqueryDateTime?No
DateCreatedGreaterThanOrEqualToqueryDateTime?No
DateCreatedGreaterThanqueryDateTime?No
DateCreatedLessThanqueryDateTime?No
DateCreatedLessThanOrEqualToqueryDateTime?No
DateCreatedNotEqualToqueryDateTime?No
DateCreatedBetweenqueryDateTime[]No
DateCreatedInqueryDateTime[]No
DateActivatedqueryDateTime?No
DateActivatedGreaterThanOrEqualToqueryDateTime?No
DateActivatedGreaterThanqueryDateTime?No
DateActivatedLessThanqueryDateTime?No
DateActivatedLessThanOrEqualToqueryDateTime?No
DateActivatedNotEqualToqueryDateTime?No
DateActivatedBetweenqueryDateTime[]No
DateActivatedInqueryDateTime[]No
HR_Staff_StaffIDquerystringNo
HR_Staff_StaffIDStartsWithquerystringNo
HR_Staff_StaffIDEndsWithquerystringNo
HR_Staff_StaffIDContainsquerystringNo
HR_Staff_StaffIDLikequerystringNo
HR_Staff_StaffIDBetweenquerystring[]No
HR_Staff_StaffIDInquerystring[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenquerybyte[]No
StatusInquerybyte[]No
ExportFileNameAndPathquerystringNo
ExportFileNameAndPathStartsWithquerystringNo
ExportFileNameAndPathEndsWithquerystringNo
ExportFileNameAndPathContainsquerystringNo
ExportFileNameAndPathLikequerystringNo
ExportFileNameAndPathBetweenquerystring[]No
ExportFileNameAndPathInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_ExportMain Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
LastSavedDateTimeformDateTimeNo
BatchNoformstringNo
DateCreatedformDateTimeNo
DateActivatedformDateTimeNo
HR_Staff_StaffIDformstringNo
StatusformbyteNo
ExportFileNameAndPathformstringNo
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_ExportMainQuery 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"],"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"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"DateCreated":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedGreaterThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThan":"0001-01-01T00:00:00.0000000","DateCreatedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedNotEqualTo":"0001-01-01T00:00:00.0000000","DateCreatedBetween":["0001-01-01T00:00:00.0000000"],"DateCreatedIn":["0001-01-01T00:00:00.0000000"],"DateActivated":"0001-01-01T00:00:00.0000000","DateActivatedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateActivatedGreaterThan":"0001-01-01T00:00:00.0000000","DateActivatedLessThan":"0001-01-01T00:00:00.0000000","DateActivatedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateActivatedNotEqualTo":"0001-01-01T00:00:00.0000000","DateActivatedBetween":["0001-01-01T00:00:00.0000000"],"DateActivatedIn":["0001-01-01T00:00:00.0000000"],"HR_Staff_StaffID":"String","HR_Staff_StaffIDStartsWith":"String","HR_Staff_StaffIDEndsWith":"String","HR_Staff_StaffIDContains":"String","HR_Staff_StaffIDLike":"String","HR_Staff_StaffIDBetween":["String"],"HR_Staff_StaffIDIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":"AA==","StatusIn":"AA==","ExportFileNameAndPath":"String","ExportFileNameAndPathStartsWith":"String","ExportFileNameAndPathEndsWith":"String","ExportFileNameAndPathContains":"String","ExportFileNameAndPathLike":"String","ExportFileNameAndPathBetween":["String"],"ExportFileNameAndPathIn":["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":[{"RecID":"String","BatchNo":"String","HR_Staff_StaffID":"String","ExportFileNameAndPath":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}