JiwaAPI

<back to all web services

EX_ExportPendingQuery

Requires Authentication
EX_ExportPendingQuery Parameters:
NameParameterData TypeRequiredDescription
ExportPendingIDquerystringNo
ExportPendingIDStartsWithquerystringNo
ExportPendingIDEndsWithquerystringNo
ExportPendingIDContainsquerystringNo
ExportPendingIDLikequerystringNo
ExportPendingIDBetweenquerystring[]No
ExportPendingIDInquerystring[]No
ActionScriptquerystringNo
ActionScriptStartsWithquerystringNo
ActionScriptEndsWithquerystringNo
ActionScriptContainsquerystringNo
ActionScriptLikequerystringNo
ActionScriptBetweenquerystring[]No
ActionScriptInquerystring[]No
ScriptErrorMessagequerystringNo
ScriptErrorMessageStartsWithquerystringNo
ScriptErrorMessageEndsWithquerystringNo
ScriptErrorMessageContainsquerystringNo
ScriptErrorMessageLikequerystringNo
ScriptErrorMessageBetweenquerystring[]No
ScriptErrorMessageInquerystring[]No
DateTimeAddedqueryDateTime?No
DateTimeAddedGreaterThanOrEqualToqueryDateTime?No
DateTimeAddedGreaterThanqueryDateTime?No
DateTimeAddedLessThanqueryDateTime?No
DateTimeAddedLessThanOrEqualToqueryDateTime?No
DateTimeAddedNotEqualToqueryDateTime?No
DateTimeAddedBetweenqueryNullable<DateTime>[]No
DateTimeAddedInqueryNullable<DateTime>[]No
StatusquerystringNo
StatusStartsWithquerystringNo
StatusEndsWithquerystringNo
StatusContainsquerystringNo
StatusLikequerystringNo
StatusBetweenquerystring[]No
StatusInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
EX_ExportPending Parameters:
NameParameterData TypeRequiredDescription
ExportPendingIDformstringNo
ActionScriptformstringNo
ScriptErrorMessageformstringNo
DateTimeAddedformDateTime?No
StatusformstringNo
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/EX_ExportPendingQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ExportPendingID":"String","ExportPendingIDStartsWith":"String","ExportPendingIDEndsWith":"String","ExportPendingIDContains":"String","ExportPendingIDLike":"String","ExportPendingIDBetween":["String"],"ExportPendingIDIn":["String"],"ActionScript":"String","ActionScriptStartsWith":"String","ActionScriptEndsWith":"String","ActionScriptContains":"String","ActionScriptLike":"String","ActionScriptBetween":["String"],"ActionScriptIn":["String"],"ScriptErrorMessage":"String","ScriptErrorMessageStartsWith":"String","ScriptErrorMessageEndsWith":"String","ScriptErrorMessageContains":"String","ScriptErrorMessageLike":"String","ScriptErrorMessageBetween":["String"],"ScriptErrorMessageIn":["String"],"DateTimeAdded":"0001-01-01T00:00:00.0000000","DateTimeAddedGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateTimeAddedGreaterThan":"0001-01-01T00:00:00.0000000","DateTimeAddedLessThan":"0001-01-01T00:00:00.0000000","DateTimeAddedLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateTimeAddedNotEqualTo":"0001-01-01T00:00:00.0000000","DateTimeAddedBetween":["0001-01-01T00:00:00.0000000"],"DateTimeAddedIn":["0001-01-01T00:00:00.0000000"],"Status":"String","StatusStartsWith":"String","StatusEndsWith":"String","StatusContains":"String","StatusLike":"String","StatusBetween":["String"],"StatusIn":["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":[{"ExportPendingID":"String","ActionScript":"String","ScriptErrorMessage":"String","DateTimeAdded":"0001-01-01T00:00:00.0000000","Status":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}