| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| IncidentNo | query | string | No | |
| IncidentNoStartsWith | query | string | No | |
| IncidentNoEndsWith | query | string | No | |
| IncidentNoContains | query | string | No | |
| IncidentNoLike | query | string | No | |
| IncidentNoBetween | query | string[] | No | |
| IncidentNoIn | query | string[] | No | |
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| ContactName | query | string | No | |
| ContactNameStartsWith | query | string | No | |
| ContactNameEndsWith | query | string | No | |
| ContactNameContains | query | string | No | |
| ContactNameLike | query | string | No | |
| ContactNameBetween | query | string[] | No | |
| ContactNameIn | query | string[] | No | |
| InvoiceID | query | string | No | |
| InvoiceIDStartsWith | query | string | No | |
| InvoiceIDEndsWith | query | string | No | |
| InvoiceIDContains | query | string | No | |
| InvoiceIDLike | query | string | No | |
| InvoiceIDBetween | query | string[] | No | |
| InvoiceIDIn | query | string[] | No | |
| InvoiceHistoryID | query | string | No | |
| InvoiceHistoryIDStartsWith | query | string | No | |
| InvoiceHistoryIDEndsWith | query | string | No | |
| InvoiceHistoryIDContains | query | string | No | |
| InvoiceHistoryIDLike | query | string | No | |
| InvoiceHistoryIDBetween | query | string[] | No | |
| InvoiceHistoryIDIn | query | string[] | No | |
| InvoiceLineID | query | string | No | |
| InvoiceLineIDStartsWith | query | string | No | |
| InvoiceLineIDEndsWith | query | string | No | |
| InvoiceLineIDContains | query | string | No | |
| InvoiceLineIDLike | query | string | No | |
| InvoiceLineIDBetween | query | string[] | No | |
| InvoiceLineIDIn | query | string[] | No | |
| SO_IncidentTypes_RecID | query | string | No | |
| SO_IncidentTypes_RecIDStartsWith | query | string | No | |
| SO_IncidentTypes_RecIDEndsWith | query | string | No | |
| SO_IncidentTypes_RecIDContains | query | string | No | |
| SO_IncidentTypes_RecIDLike | query | string | No | |
| SO_IncidentTypes_RecIDBetween | query | string[] | No | |
| SO_IncidentTypes_RecIDIn | query | string[] | No | |
| Details | query | string | No | |
| DetailsStartsWith | query | string | No | |
| DetailsEndsWith | query | string | No | |
| DetailsContains | query | string | No | |
| DetailsLike | query | string | No | |
| DetailsBetween | query | string[] | No | |
| DetailsIn | query | string[] | No | |
| CreatedDateTime | query | DateTime? | No | |
| CreatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| CreatedDateTimeGreaterThan | query | DateTime? | No | |
| CreatedDateTimeLessThan | query | DateTime? | No | |
| CreatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| CreatedDateTimeNotEqualTo | query | DateTime? | No | |
| CreatedDateTimeBetween | query | DateTime[] | No | |
| CreatedDateTimeIn | query | DateTime[] | No | |
| CreatedByStaffID | query | string | No | |
| CreatedByStaffIDStartsWith | query | string | No | |
| CreatedByStaffIDEndsWith | query | string | No | |
| CreatedByStaffIDContains | query | string | No | |
| CreatedByStaffIDLike | query | string | No | |
| CreatedByStaffIDBetween | query | string[] | No | |
| CreatedByStaffIDIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | No | |
| LastSavedByStaffID | query | string | No | |
| LastSavedByStaffIDStartsWith | query | string | No | |
| LastSavedByStaffIDEndsWith | query | string | No | |
| LastSavedByStaffIDContains | query | string | No | |
| LastSavedByStaffIDLike | query | string | No | |
| LastSavedByStaffIDBetween | query | string[] | No | |
| LastSavedByStaffIDIn | query | string[] | No | |
| IncidentDate | query | DateTime? | No | |
| IncidentDateGreaterThanOrEqualTo | query | DateTime? | No | |
| IncidentDateGreaterThan | query | DateTime? | No | |
| IncidentDateLessThan | query | DateTime? | No | |
| IncidentDateLessThanOrEqualTo | query | DateTime? | No | |
| IncidentDateNotEqualTo | query | DateTime? | No | |
| IncidentDateBetween | query | Nullable<DateTime>[] | No | |
| IncidentDateIn | query | Nullable<DateTime>[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | string | No | |
| IncidentNo | form | string | No | |
| DebtorID | form | string | No | |
| ContactName | form | string | No | |
| InvoiceID | form | string | No | |
| InvoiceHistoryID | form | string | No | |
| InvoiceLineID | form | string | No | |
| SO_IncidentTypes_RecID | form | string | No | |
| Details | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| CreatedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSavedByStaffID | form | string | No | |
| IncidentDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
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
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"}}}