JiwaAPI

<back to all web services

SO_IncidentsQuery

Requires Authentication
SO_IncidentsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
IncidentNoquerystringNo
IncidentNoStartsWithquerystringNo
IncidentNoEndsWithquerystringNo
IncidentNoContainsquerystringNo
IncidentNoLikequerystringNo
IncidentNoBetweenquerystring[]No
IncidentNoInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
ContactNamequerystringNo
ContactNameStartsWithquerystringNo
ContactNameEndsWithquerystringNo
ContactNameContainsquerystringNo
ContactNameLikequerystringNo
ContactNameBetweenquerystring[]No
ContactNameInquerystring[]No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
InvoiceHistoryIDquerystringNo
InvoiceHistoryIDStartsWithquerystringNo
InvoiceHistoryIDEndsWithquerystringNo
InvoiceHistoryIDContainsquerystringNo
InvoiceHistoryIDLikequerystringNo
InvoiceHistoryIDBetweenquerystring[]No
InvoiceHistoryIDInquerystring[]No
InvoiceLineIDquerystringNo
InvoiceLineIDStartsWithquerystringNo
InvoiceLineIDEndsWithquerystringNo
InvoiceLineIDContainsquerystringNo
InvoiceLineIDLikequerystringNo
InvoiceLineIDBetweenquerystring[]No
InvoiceLineIDInquerystring[]No
SO_IncidentTypes_RecIDquerystringNo
SO_IncidentTypes_RecIDStartsWithquerystringNo
SO_IncidentTypes_RecIDEndsWithquerystringNo
SO_IncidentTypes_RecIDContainsquerystringNo
SO_IncidentTypes_RecIDLikequerystringNo
SO_IncidentTypes_RecIDBetweenquerystring[]No
SO_IncidentTypes_RecIDInquerystring[]No
DetailsquerystringNo
DetailsStartsWithquerystringNo
DetailsEndsWithquerystringNo
DetailsContainsquerystringNo
DetailsLikequerystringNo
DetailsBetweenquerystring[]No
DetailsInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryDateTime[]No
CreatedDateTimeInqueryDateTime[]No
CreatedByStaffIDquerystringNo
CreatedByStaffIDStartsWithquerystringNo
CreatedByStaffIDEndsWithquerystringNo
CreatedByStaffIDContainsquerystringNo
CreatedByStaffIDLikequerystringNo
CreatedByStaffIDBetweenquerystring[]No
CreatedByStaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
LastSavedByStaffIDquerystringNo
LastSavedByStaffIDStartsWithquerystringNo
LastSavedByStaffIDEndsWithquerystringNo
LastSavedByStaffIDContainsquerystringNo
LastSavedByStaffIDLikequerystringNo
LastSavedByStaffIDBetweenquerystring[]No
LastSavedByStaffIDInquerystring[]No
IncidentDatequeryDateTime?No
IncidentDateGreaterThanOrEqualToqueryDateTime?No
IncidentDateGreaterThanqueryDateTime?No
IncidentDateLessThanqueryDateTime?No
IncidentDateLessThanOrEqualToqueryDateTime?No
IncidentDateNotEqualToqueryDateTime?No
IncidentDateBetweenqueryNullable<DateTime>[]No
IncidentDateInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_Incidents Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
IncidentNoformstringNo
DebtorIDformstringNo
ContactNameformstringNo
InvoiceIDformstringNo
InvoiceHistoryIDformstringNo
InvoiceLineIDformstringNo
SO_IncidentTypes_RecIDformstringNo
DetailsformstringNo
CreatedDateTimeformDateTimeNo
CreatedByStaffIDformstringNo
LastSavedDateTimeformDateTimeNo
LastSavedByStaffIDformstringNo
IncidentDateformDateTime?No
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/SO_IncidentsQuery 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"],"IncidentNo":"String","IncidentNoStartsWith":"String","IncidentNoEndsWith":"String","IncidentNoContains":"String","IncidentNoLike":"String","IncidentNoBetween":["String"],"IncidentNoIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"ContactName":"String","ContactNameStartsWith":"String","ContactNameEndsWith":"String","ContactNameContains":"String","ContactNameLike":"String","ContactNameBetween":["String"],"ContactNameIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"InvoiceLineID":"String","InvoiceLineIDStartsWith":"String","InvoiceLineIDEndsWith":"String","InvoiceLineIDContains":"String","InvoiceLineIDLike":"String","InvoiceLineIDBetween":["String"],"InvoiceLineIDIn":["String"],"SO_IncidentTypes_RecID":"String","SO_IncidentTypes_RecIDStartsWith":"String","SO_IncidentTypes_RecIDEndsWith":"String","SO_IncidentTypes_RecIDContains":"String","SO_IncidentTypes_RecIDLike":"String","SO_IncidentTypes_RecIDBetween":["String"],"SO_IncidentTypes_RecIDIn":["String"],"Details":"String","DetailsStartsWith":"String","DetailsEndsWith":"String","DetailsContains":"String","DetailsLike":"String","DetailsBetween":["String"],"DetailsIn":["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"],"CreatedByStaffID":"String","CreatedByStaffIDStartsWith":"String","CreatedByStaffIDEndsWith":"String","CreatedByStaffIDContains":"String","CreatedByStaffIDLike":"String","CreatedByStaffIDBetween":["String"],"CreatedByStaffIDIn":["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"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["String"],"IncidentDate":"0001-01-01T00:00:00.0000000","IncidentDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","IncidentDateGreaterThan":"0001-01-01T00:00:00.0000000","IncidentDateLessThan":"0001-01-01T00:00:00.0000000","IncidentDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","IncidentDateNotEqualTo":"0001-01-01T00:00:00.0000000","IncidentDateBetween":["0001-01-01T00:00:00.0000000"],"IncidentDateIn":["0001-01-01T00:00:00.0000000"],"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","IncidentNo":"String","DebtorID":"String","ContactName":"String","InvoiceID":"String","InvoiceHistoryID":"String","InvoiceLineID":"String","SO_IncidentTypes_RecID":"String","Details":"String","CreatedByStaffID":"String","LastSavedByStaffID":"String","IncidentDate":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}