| 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 | |
| AR_Main_RecID | query | string | No | |
| AR_Main_RecIDStartsWith | query | string | No | |
| AR_Main_RecIDEndsWith | query | string | No | |
| AR_Main_RecIDContains | query | string | No | |
| AR_Main_RecIDLike | query | string | No | |
| AR_Main_RecIDBetween | query | string[] | No | |
| AR_Main_RecIDIn | query | string[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| Enabled | query | byte? | No | |
| EnabledGreaterThanOrEqualTo | query | byte? | No | |
| EnabledGreaterThan | query | byte? | No | |
| EnabledLessThan | query | byte? | No | |
| EnabledLessThanOrEqualTo | query | byte? | No | |
| EnabledNotEqualTo | query | byte? | No | |
| EnabledBetween | query | Nullable<Byte>[] | No | |
| EnabledIn | query | Nullable<Byte>[] | No | |
| FrequencyType | query | int? | No | |
| FrequencyTypeGreaterThanOrEqualTo | query | int? | No | |
| FrequencyTypeGreaterThan | query | int? | No | |
| FrequencyTypeLessThan | query | int? | No | |
| FrequencyTypeLessThanOrEqualTo | query | int? | No | |
| FrequencyTypeNotEqualTo | query | int? | No | |
| FrequencyTypeBetween | query | int[] | No | |
| FrequencyTypeIn | query | int[] | No | |
| FrequencyInterval | query | int? | No | |
| FrequencyIntervalGreaterThanOrEqualTo | query | int? | No | |
| FrequencyIntervalGreaterThan | query | int? | No | |
| FrequencyIntervalLessThan | query | int? | No | |
| FrequencyIntervalLessThanOrEqualTo | query | int? | No | |
| FrequencyIntervalNotEqualTo | query | int? | No | |
| FrequencyIntervalBetween | query | int[] | No | |
| FrequencyIntervalIn | query | int[] | No | |
| FrequencySubdayType | query | int? | No | |
| FrequencySubdayTypeGreaterThanOrEqualTo | query | int? | No | |
| FrequencySubdayTypeGreaterThan | query | int? | No | |
| FrequencySubdayTypeLessThan | query | int? | No | |
| FrequencySubdayTypeLessThanOrEqualTo | query | int? | No | |
| FrequencySubdayTypeNotEqualTo | query | int? | No | |
| FrequencySubdayTypeBetween | query | int[] | No | |
| FrequencySubdayTypeIn | query | int[] | No | |
| FrequencySubdayInterval | query | int? | No | |
| FrequencySubdayIntervalGreaterThanOrEqualTo | query | int? | No | |
| FrequencySubdayIntervalGreaterThan | query | int? | No | |
| FrequencySubdayIntervalLessThan | query | int? | No | |
| FrequencySubdayIntervalLessThanOrEqualTo | query | int? | No | |
| FrequencySubdayIntervalNotEqualTo | query | int? | No | |
| FrequencySubdayIntervalBetween | query | int[] | No | |
| FrequencySubdayIntervalIn | query | int[] | No | |
| FrequencyRelativeInterval | query | int? | No | |
| FrequencyRelativeIntervalGreaterThanOrEqualTo | query | int? | No | |
| FrequencyRelativeIntervalGreaterThan | query | int? | No | |
| FrequencyRelativeIntervalLessThan | query | int? | No | |
| FrequencyRelativeIntervalLessThanOrEqualTo | query | int? | No | |
| FrequencyRelativeIntervalNotEqualTo | query | int? | No | |
| FrequencyRelativeIntervalBetween | query | int[] | No | |
| FrequencyRelativeIntervalIn | query | int[] | No | |
| FrequencyRecurrenceFactor | query | int? | No | |
| FrequencyRecurrenceFactorGreaterThanOrEqualTo | query | int? | No | |
| FrequencyRecurrenceFactorGreaterThan | query | int? | No | |
| FrequencyRecurrenceFactorLessThan | query | int? | No | |
| FrequencyRecurrenceFactorLessThanOrEqualTo | query | int? | No | |
| FrequencyRecurrenceFactorNotEqualTo | query | int? | No | |
| FrequencyRecurrenceFactorBetween | query | int[] | No | |
| FrequencyRecurrenceFactorIn | query | int[] | No | |
| StartDateTime | query | DateTime? | No | |
| StartDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| StartDateTimeGreaterThan | query | DateTime? | No | |
| StartDateTimeLessThan | query | DateTime? | No | |
| StartDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| StartDateTimeNotEqualTo | query | DateTime? | No | |
| StartDateTimeBetween | query | DateTime[] | No | |
| StartDateTimeIn | query | DateTime[] | No | |
| EndDateTime | query | DateTime? | No | |
| EndDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| EndDateTimeGreaterThan | query | DateTime? | No | |
| EndDateTimeLessThan | query | DateTime? | No | |
| EndDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| EndDateTimeNotEqualTo | query | DateTime? | No | |
| EndDateTimeBetween | query | DateTime[] | No | |
| EndDateTimeIn | query | DateTime[] | 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 |
| 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 | |
| AR_Main_RecID | form | string | No | |
| Name | form | string | No | |
| Enabled | form | byte? | No | |
| FrequencyType | form | int | No | |
| FrequencyInterval | form | int | No | |
| FrequencySubdayType | form | int | No | |
| FrequencySubdayInterval | form | int | No | |
| FrequencyRelativeInterval | form | int | No | |
| FrequencyRecurrenceFactor | form | int | No | |
| StartDateTime | form | DateTime | No | |
| EndDateTime | form | DateTime | No | |
| CreatedDateTime | form | DateTime | No | |
| CreatedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| LastSavedByStaffID | form | string | 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/AR_SchedulesQuery 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"],"AR_Main_RecID":"String","AR_Main_RecIDStartsWith":"String","AR_Main_RecIDEndsWith":"String","AR_Main_RecIDContains":"String","AR_Main_RecIDLike":"String","AR_Main_RecIDBetween":["String"],"AR_Main_RecIDIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"Enabled":0,"EnabledGreaterThanOrEqualTo":0,"EnabledGreaterThan":0,"EnabledLessThan":0,"EnabledLessThanOrEqualTo":0,"EnabledNotEqualTo":0,"EnabledBetween":[0],"EnabledIn":[0],"FrequencyType":0,"FrequencyTypeGreaterThanOrEqualTo":0,"FrequencyTypeGreaterThan":0,"FrequencyTypeLessThan":0,"FrequencyTypeLessThanOrEqualTo":0,"FrequencyTypeNotEqualTo":0,"FrequencyTypeBetween":[0],"FrequencyTypeIn":[0],"FrequencyInterval":0,"FrequencyIntervalGreaterThanOrEqualTo":0,"FrequencyIntervalGreaterThan":0,"FrequencyIntervalLessThan":0,"FrequencyIntervalLessThanOrEqualTo":0,"FrequencyIntervalNotEqualTo":0,"FrequencyIntervalBetween":[0],"FrequencyIntervalIn":[0],"FrequencySubdayType":0,"FrequencySubdayTypeGreaterThanOrEqualTo":0,"FrequencySubdayTypeGreaterThan":0,"FrequencySubdayTypeLessThan":0,"FrequencySubdayTypeLessThanOrEqualTo":0,"FrequencySubdayTypeNotEqualTo":0,"FrequencySubdayTypeBetween":[0],"FrequencySubdayTypeIn":[0],"FrequencySubdayInterval":0,"FrequencySubdayIntervalGreaterThanOrEqualTo":0,"FrequencySubdayIntervalGreaterThan":0,"FrequencySubdayIntervalLessThan":0,"FrequencySubdayIntervalLessThanOrEqualTo":0,"FrequencySubdayIntervalNotEqualTo":0,"FrequencySubdayIntervalBetween":[0],"FrequencySubdayIntervalIn":[0],"FrequencyRelativeInterval":0,"FrequencyRelativeIntervalGreaterThanOrEqualTo":0,"FrequencyRelativeIntervalGreaterThan":0,"FrequencyRelativeIntervalLessThan":0,"FrequencyRelativeIntervalLessThanOrEqualTo":0,"FrequencyRelativeIntervalNotEqualTo":0,"FrequencyRelativeIntervalBetween":[0],"FrequencyRelativeIntervalIn":[0],"FrequencyRecurrenceFactor":0,"FrequencyRecurrenceFactorGreaterThanOrEqualTo":0,"FrequencyRecurrenceFactorGreaterThan":0,"FrequencyRecurrenceFactorLessThan":0,"FrequencyRecurrenceFactorLessThanOrEqualTo":0,"FrequencyRecurrenceFactorNotEqualTo":0,"FrequencyRecurrenceFactorBetween":[0],"FrequencyRecurrenceFactorIn":[0],"StartDateTime":"0001-01-01T00:00:00.0000000","StartDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","StartDateTimeLessThan":"0001-01-01T00:00:00.0000000","StartDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateTimeBetween":["0001-01-01T00:00:00.0000000"],"StartDateTimeIn":["0001-01-01T00:00:00.0000000"],"EndDateTime":"0001-01-01T00:00:00.0000000","EndDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","EndDateTimeLessThan":"0001-01-01T00:00:00.0000000","EndDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","EndDateTimeBetween":["0001-01-01T00:00:00.0000000"],"EndDateTimeIn":["0001-01-01T00:00:00.0000000"],"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"],"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","AR_Main_RecID":"String","Name":"String","Enabled":0,"CreatedByStaffID":"String","LastSavedByStaffID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}