| 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 | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| NoteTypeID | query | string | No | |
| NoteTypeIDStartsWith | query | string | No | |
| NoteTypeIDEndsWith | query | string | No | |
| NoteTypeIDContains | query | string | No | |
| NoteTypeIDLike | query | string | No | |
| NoteTypeIDBetween | query | string[] | No | |
| NoteTypeIDIn | 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 | |
| NoteText | query | string | No | |
| NoteTextStartsWith | query | string | No | |
| NoteTextEndsWith | query | string | No | |
| NoteTextContains | query | string | No | |
| NoteTextLike | query | string | No | |
| NoteTextBetween | query | string[] | No | |
| NoteTextIn | query | string[] | No | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | 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 | |
| StaffID | form | string | No | |
| NoteTypeID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSavedByStaffID | form | string | No | |
| NoteText | form | string | No | |
| ItemNo | form | int | 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/HR_NotesQuery 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"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"NoteTypeID":"String","NoteTypeIDStartsWith":"String","NoteTypeIDEndsWith":"String","NoteTypeIDContains":"String","NoteTypeIDLike":"String","NoteTypeIDBetween":["String"],"NoteTypeIDIn":["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"],"NoteText":"String","NoteTextStartsWith":"String","NoteTextEndsWith":"String","NoteTextContains":"String","NoteTextLike":"String","NoteTextBetween":["String"],"NoteTextIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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","StaffID":"String","NoteTypeID":"String","LastSavedByStaffID":"String","NoteText":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}