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 | |
TD_Main_RecID | query | string | No | |
TD_Main_RecIDStartsWith | query | string | No | |
TD_Main_RecIDEndsWith | query | string | No | |
TD_Main_RecIDContains | query | string | No | |
TD_Main_RecIDLike | query | string | No | |
TD_Main_RecIDBetween | query | string[] | No | |
TD_Main_RecIDIn | query | string[] | No | |
HR_Staff_RecID | query | string | No | |
HR_Staff_RecIDStartsWith | query | string | No | |
HR_Staff_RecIDEndsWith | query | string | No | |
HR_Staff_RecIDContains | query | string | No | |
HR_Staff_RecIDLike | query | string | No | |
HR_Staff_RecIDBetween | query | string[] | No | |
HR_Staff_RecIDIn | query | string[] | No | |
NotificationEnabled | query | bool? | No | |
NotificationText | query | string | No | |
NotificationTextStartsWith | query | string | No | |
NotificationTextEndsWith | query | string | No | |
NotificationTextContains | query | string | No | |
NotificationTextLike | query | string | No | |
NotificationTextBetween | query | string[] | No | |
NotificationTextIn | 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 | |
RowHash | query | byte[] | 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 | |
NotificationSent | query | bool? | 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 | |
TD_Main_RecID | form | string | No | |
HR_Staff_RecID | form | string | No | |
NotificationEnabled | form | bool | No | |
NotificationText | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
RowHash | form | byte[] | No | |
ItemNo | form | int | No | |
NotificationSent | form | bool | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/TD_CollaborationsQuery 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"],"TD_Main_RecID":"String","TD_Main_RecIDStartsWith":"String","TD_Main_RecIDEndsWith":"String","TD_Main_RecIDContains":"String","TD_Main_RecIDLike":"String","TD_Main_RecIDBetween":["String"],"TD_Main_RecIDIn":["String"],"HR_Staff_RecID":"String","HR_Staff_RecIDStartsWith":"String","HR_Staff_RecIDEndsWith":"String","HR_Staff_RecIDContains":"String","HR_Staff_RecIDLike":"String","HR_Staff_RecIDBetween":["String"],"HR_Staff_RecIDIn":["String"],"NotificationEnabled":false,"NotificationText":"String","NotificationTextStartsWith":"String","NotificationTextEndsWith":"String","NotificationTextContains":"String","NotificationTextLike":"String","NotificationTextBetween":["String"],"NotificationTextIn":["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"],"RowHash":"AA==","ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"NotificationSent":false,"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","TD_Main_RecID":"String","HR_Staff_RecID":"String","NotificationText":"String","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}