| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| SY_Plugin_RecID | query | Guid? | No | |
| SY_Plugin_RecIDIn | query | Guid[] | 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 | |
| IsEnabled | query | bool? | No | |
| ScheduleType | query | byte? | No | |
| ScheduleTypeGreaterThanOrEqualTo | query | byte? | No | |
| ScheduleTypeGreaterThan | query | byte? | No | |
| ScheduleTypeLessThan | query | byte? | No | |
| ScheduleTypeLessThanOrEqualTo | query | byte? | No | |
| ScheduleTypeNotEqualTo | query | byte? | No | |
| ScheduleTypeBetween | query | byte[] | No | |
| ScheduleTypeIn | query | byte[] | No | |
| OccurrenceType | query | byte? | No | |
| OccurrenceTypeGreaterThanOrEqualTo | query | byte? | No | |
| OccurrenceTypeGreaterThan | query | byte? | No | |
| OccurrenceTypeLessThan | query | byte? | No | |
| OccurrenceTypeLessThanOrEqualTo | query | byte? | No | |
| OccurrenceTypeNotEqualTo | query | byte? | No | |
| OccurrenceTypeBetween | query | byte[] | No | |
| OccurrenceTypeIn | query | byte[] | No | |
| OccurrenceFrequencyInterval | query | int? | No | |
| OccurrenceFrequencyIntervalGreaterThanOrEqualTo | query | int? | No | |
| OccurrenceFrequencyIntervalGreaterThan | query | int? | No | |
| OccurrenceFrequencyIntervalLessThan | query | int? | No | |
| OccurrenceFrequencyIntervalLessThanOrEqualTo | query | int? | No | |
| OccurrenceFrequencyIntervalNotEqualTo | query | int? | No | |
| OccurrenceFrequencyIntervalBetween | query | int[] | No | |
| OccurrenceFrequencyIntervalIn | query | int[] | No | |
| DailyFrequencyType | query | byte? | No | |
| DailyFrequencyTypeGreaterThanOrEqualTo | query | byte? | No | |
| DailyFrequencyTypeGreaterThan | query | byte? | No | |
| DailyFrequencyTypeLessThan | query | byte? | No | |
| DailyFrequencyTypeLessThanOrEqualTo | query | byte? | No | |
| DailyFrequencyTypeNotEqualTo | query | byte? | No | |
| DailyFrequencyTypeBetween | query | byte[] | No | |
| DailyFrequencyTypeIn | query | byte[] | No | |
| DailyOccursOnceTime | query | long? | No | |
| DailyOccursOnceTimeGreaterThanOrEqualTo | query | long? | No | |
| DailyOccursOnceTimeGreaterThan | query | long? | No | |
| DailyOccursOnceTimeLessThan | query | long? | No | |
| DailyOccursOnceTimeLessThanOrEqualTo | query | long? | No | |
| DailyOccursOnceTimeNotEqualTo | query | long? | No | |
| DailyOccursOnceTimeBetween | query | long[] | No | |
| DailyOccursOnceTimeIn | query | long[] | No | |
| DailyRepeatsInterval | query | int? | No | |
| DailyRepeatsIntervalGreaterThanOrEqualTo | query | int? | No | |
| DailyRepeatsIntervalGreaterThan | query | int? | No | |
| DailyRepeatsIntervalLessThan | query | int? | No | |
| DailyRepeatsIntervalLessThanOrEqualTo | query | int? | No | |
| DailyRepeatsIntervalNotEqualTo | query | int? | No | |
| DailyRepeatsIntervalBetween | query | int[] | No | |
| DailyRepeatsIntervalIn | query | int[] | No | |
| DailyRepeatsStartTime | query | long? | No | |
| DailyRepeatsStartTimeGreaterThanOrEqualTo | query | long? | No | |
| DailyRepeatsStartTimeGreaterThan | query | long? | No | |
| DailyRepeatsStartTimeLessThan | query | long? | No | |
| DailyRepeatsStartTimeLessThanOrEqualTo | query | long? | No | |
| DailyRepeatsStartTimeNotEqualTo | query | long? | No | |
| DailyRepeatsStartTimeBetween | query | long[] | No | |
| DailyRepeatsStartTimeIn | query | long[] | No | |
| DailyRepeatsEndTime | query | long? | No | |
| DailyRepeatsEndTimeGreaterThanOrEqualTo | query | long? | No | |
| DailyRepeatsEndTimeGreaterThan | query | long? | No | |
| DailyRepeatsEndTimeLessThan | query | long? | No | |
| DailyRepeatsEndTimeLessThanOrEqualTo | query | long? | No | |
| DailyRepeatsEndTimeNotEqualTo | query | long? | No | |
| DailyRepeatsEndTimeBetween | query | long[] | No | |
| DailyRepeatsEndTimeIn | query | long[] | No | |
| WeeklyRepeatsInterval | query | int? | No | |
| WeeklyRepeatsIntervalGreaterThanOrEqualTo | query | int? | No | |
| WeeklyRepeatsIntervalGreaterThan | query | int? | No | |
| WeeklyRepeatsIntervalLessThan | query | int? | No | |
| WeeklyRepeatsIntervalLessThanOrEqualTo | query | int? | No | |
| WeeklyRepeatsIntervalNotEqualTo | query | int? | No | |
| WeeklyRepeatsIntervalBetween | query | int[] | No | |
| WeeklyRepeatsIntervalIn | query | int[] | No | |
| WeeklyDaysOfWeek | query | byte? | No | |
| WeeklyDaysOfWeekGreaterThanOrEqualTo | query | byte? | No | |
| WeeklyDaysOfWeekGreaterThan | query | byte? | No | |
| WeeklyDaysOfWeekLessThan | query | byte? | No | |
| WeeklyDaysOfWeekLessThanOrEqualTo | query | byte? | No | |
| WeeklyDaysOfWeekNotEqualTo | query | byte? | No | |
| WeeklyDaysOfWeekBetween | query | byte[] | No | |
| WeeklyDaysOfWeekIn | query | byte[] | No | |
| MonthlyFrequencyType | query | byte? | No | |
| MonthlyFrequencyTypeGreaterThanOrEqualTo | query | byte? | No | |
| MonthlyFrequencyTypeGreaterThan | query | byte? | No | |
| MonthlyFrequencyTypeLessThan | query | byte? | No | |
| MonthlyFrequencyTypeLessThanOrEqualTo | query | byte? | No | |
| MonthlyFrequencyTypeNotEqualTo | query | byte? | No | |
| MonthlyFrequencyTypeBetween | query | byte[] | No | |
| MonthlyFrequencyTypeIn | query | byte[] | No | |
| MonthlyDayOfMonth | query | byte? | No | |
| MonthlyDayOfMonthGreaterThanOrEqualTo | query | byte? | No | |
| MonthlyDayOfMonthGreaterThan | query | byte? | No | |
| MonthlyDayOfMonthLessThan | query | byte? | No | |
| MonthlyDayOfMonthLessThanOrEqualTo | query | byte? | No | |
| MonthlyDayOfMonthNotEqualTo | query | byte? | No | |
| MonthlyDayOfMonthBetween | query | byte[] | No | |
| MonthlyDayOfMonthIn | query | byte[] | No | |
| MonthlyRepeatInterval | query | int? | No | |
| MonthlyRepeatIntervalGreaterThanOrEqualTo | query | int? | No | |
| MonthlyRepeatIntervalGreaterThan | query | int? | No | |
| MonthlyRepeatIntervalLessThan | query | int? | No | |
| MonthlyRepeatIntervalLessThanOrEqualTo | query | int? | No | |
| MonthlyRepeatIntervalNotEqualTo | query | int? | No | |
| MonthlyRepeatIntervalBetween | query | int[] | No | |
| MonthlyRepeatIntervalIn | query | int[] | No | |
| MonthlyFrequencyAdjective | query | byte? | No | |
| MonthlyFrequencyAdjectiveGreaterThanOrEqualTo | query | byte? | No | |
| MonthlyFrequencyAdjectiveGreaterThan | query | byte? | No | |
| MonthlyFrequencyAdjectiveLessThan | query | byte? | No | |
| MonthlyFrequencyAdjectiveLessThanOrEqualTo | query | byte? | No | |
| MonthlyFrequencyAdjectiveNotEqualTo | query | byte? | No | |
| MonthlyFrequencyAdjectiveBetween | query | byte[] | No | |
| MonthlyFrequencyAdjectiveIn | query | byte[] | No | |
| MonthlyFrequencyDayOfWeek | query | byte? | No | |
| MonthlyFrequencyDayOfWeekGreaterThanOrEqualTo | query | byte? | No | |
| MonthlyFrequencyDayOfWeekGreaterThan | query | byte? | No | |
| MonthlyFrequencyDayOfWeekLessThan | query | byte? | No | |
| MonthlyFrequencyDayOfWeekLessThanOrEqualTo | query | byte? | No | |
| MonthlyFrequencyDayOfWeekNotEqualTo | query | byte? | No | |
| MonthlyFrequencyDayOfWeekBetween | query | byte[] | No | |
| MonthlyFrequencyDayOfWeekIn | query | byte[] | No | |
| StartDate | query | DateTime? | No | |
| StartDateGreaterThanOrEqualTo | query | DateTime? | No | |
| StartDateGreaterThan | query | DateTime? | No | |
| StartDateLessThan | query | DateTime? | No | |
| StartDateLessThanOrEqualTo | query | DateTime? | No | |
| StartDateNotEqualTo | query | DateTime? | No | |
| StartDateBetween | query | DateTime[] | No | |
| StartDateIn | query | DateTime[] | No | |
| HasEndDate | query | bool? | No | |
| EndDate | query | DateTime? | No | |
| EndDateGreaterThanOrEqualTo | query | DateTime? | No | |
| EndDateGreaterThan | query | DateTime? | No | |
| EndDateLessThan | query | DateTime? | No | |
| EndDateLessThanOrEqualTo | query | DateTime? | No | |
| EndDateNotEqualTo | query | DateTime? | No | |
| EndDateBetween | query | Nullable<DateTime>[] | No | |
| EndDateIn | query | Nullable<DateTime>[] | No | |
| ItemNo | query | short? | No | |
| ItemNoGreaterThanOrEqualTo | query | short? | No | |
| ItemNoGreaterThan | query | short? | No | |
| ItemNoLessThan | query | short? | No | |
| ItemNoLessThanOrEqualTo | query | short? | No | |
| ItemNoNotEqualTo | query | short? | No | |
| ItemNoBetween | query | short[] | No | |
| ItemNoIn | query | short[] | No | |
| LastRunDate | query | DateTime? | No | |
| LastRunDateGreaterThanOrEqualTo | query | DateTime? | No | |
| LastRunDateGreaterThan | query | DateTime? | No | |
| LastRunDateLessThan | query | DateTime? | No | |
| LastRunDateLessThanOrEqualTo | query | DateTime? | No | |
| LastRunDateNotEqualTo | query | DateTime? | No | |
| LastRunDateBetween | query | Nullable<DateTime>[] | No | |
| LastRunDateIn | query | Nullable<DateTime>[] | No | |
| NextRunDate | query | DateTime? | No | |
| NextRunDateGreaterThanOrEqualTo | query | DateTime? | No | |
| NextRunDateGreaterThan | query | DateTime? | No | |
| NextRunDateLessThan | query | DateTime? | No | |
| NextRunDateLessThanOrEqualTo | query | DateTime? | No | |
| NextRunDateNotEqualTo | query | DateTime? | No | |
| NextRunDateBetween | query | Nullable<DateTime>[] | No | |
| NextRunDateIn | query | Nullable<DateTime>[] | No | |
| RowHash | query | byte[] | 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 | Guid | No | |
| SY_Plugin_RecID | form | Guid | No | |
| Name | form | string | No | |
| IsEnabled | form | bool | No | |
| ScheduleType | form | byte | No | |
| OccurrenceType | form | byte | No | |
| OccurrenceFrequencyInterval | form | int | No | |
| DailyFrequencyType | form | byte | No | |
| DailyOccursOnceTime | form | long | No | |
| DailyRepeatsInterval | form | int | No | |
| DailyRepeatsStartTime | form | long | No | |
| DailyRepeatsEndTime | form | long | No | |
| WeeklyRepeatsInterval | form | int | No | |
| WeeklyDaysOfWeek | form | byte | No | |
| MonthlyFrequencyType | form | byte | No | |
| MonthlyDayOfMonth | form | byte | No | |
| MonthlyRepeatInterval | form | int | No | |
| MonthlyFrequencyAdjective | form | byte | No | |
| MonthlyFrequencyDayOfWeek | form | byte | No | |
| StartDate | form | DateTime | No | |
| HasEndDate | form | bool | No | |
| EndDate | form | DateTime? | No | |
| ItemNo | form | short | No | |
| LastRunDate | form | DateTime? | No | |
| NextRunDate | form | DateTime? | No | |
| RowHash | form | byte[] | 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/SY_PluginScheduleQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"SY_Plugin_RecID":"00000000000000000000000000000000","SY_Plugin_RecIDIn":["00000000-0000-0000-0000-000000000000"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"IsEnabled":false,"ScheduleType":0,"ScheduleTypeGreaterThanOrEqualTo":0,"ScheduleTypeGreaterThan":0,"ScheduleTypeLessThan":0,"ScheduleTypeLessThanOrEqualTo":0,"ScheduleTypeNotEqualTo":0,"ScheduleTypeBetween":"AA==","ScheduleTypeIn":"AA==","OccurrenceType":0,"OccurrenceTypeGreaterThanOrEqualTo":0,"OccurrenceTypeGreaterThan":0,"OccurrenceTypeLessThan":0,"OccurrenceTypeLessThanOrEqualTo":0,"OccurrenceTypeNotEqualTo":0,"OccurrenceTypeBetween":"AA==","OccurrenceTypeIn":"AA==","OccurrenceFrequencyInterval":0,"OccurrenceFrequencyIntervalGreaterThanOrEqualTo":0,"OccurrenceFrequencyIntervalGreaterThan":0,"OccurrenceFrequencyIntervalLessThan":0,"OccurrenceFrequencyIntervalLessThanOrEqualTo":0,"OccurrenceFrequencyIntervalNotEqualTo":0,"OccurrenceFrequencyIntervalBetween":[0],"OccurrenceFrequencyIntervalIn":[0],"DailyFrequencyType":0,"DailyFrequencyTypeGreaterThanOrEqualTo":0,"DailyFrequencyTypeGreaterThan":0,"DailyFrequencyTypeLessThan":0,"DailyFrequencyTypeLessThanOrEqualTo":0,"DailyFrequencyTypeNotEqualTo":0,"DailyFrequencyTypeBetween":"AA==","DailyFrequencyTypeIn":"AA==","DailyOccursOnceTime":0,"DailyOccursOnceTimeGreaterThanOrEqualTo":0,"DailyOccursOnceTimeGreaterThan":0,"DailyOccursOnceTimeLessThan":0,"DailyOccursOnceTimeLessThanOrEqualTo":0,"DailyOccursOnceTimeNotEqualTo":0,"DailyOccursOnceTimeBetween":[0],"DailyOccursOnceTimeIn":[0],"DailyRepeatsInterval":0,"DailyRepeatsIntervalGreaterThanOrEqualTo":0,"DailyRepeatsIntervalGreaterThan":0,"DailyRepeatsIntervalLessThan":0,"DailyRepeatsIntervalLessThanOrEqualTo":0,"DailyRepeatsIntervalNotEqualTo":0,"DailyRepeatsIntervalBetween":[0],"DailyRepeatsIntervalIn":[0],"DailyRepeatsStartTime":0,"DailyRepeatsStartTimeGreaterThanOrEqualTo":0,"DailyRepeatsStartTimeGreaterThan":0,"DailyRepeatsStartTimeLessThan":0,"DailyRepeatsStartTimeLessThanOrEqualTo":0,"DailyRepeatsStartTimeNotEqualTo":0,"DailyRepeatsStartTimeBetween":[0],"DailyRepeatsStartTimeIn":[0],"DailyRepeatsEndTime":0,"DailyRepeatsEndTimeGreaterThanOrEqualTo":0,"DailyRepeatsEndTimeGreaterThan":0,"DailyRepeatsEndTimeLessThan":0,"DailyRepeatsEndTimeLessThanOrEqualTo":0,"DailyRepeatsEndTimeNotEqualTo":0,"DailyRepeatsEndTimeBetween":[0],"DailyRepeatsEndTimeIn":[0],"WeeklyRepeatsInterval":0,"WeeklyRepeatsIntervalGreaterThanOrEqualTo":0,"WeeklyRepeatsIntervalGreaterThan":0,"WeeklyRepeatsIntervalLessThan":0,"WeeklyRepeatsIntervalLessThanOrEqualTo":0,"WeeklyRepeatsIntervalNotEqualTo":0,"WeeklyRepeatsIntervalBetween":[0],"WeeklyRepeatsIntervalIn":[0],"WeeklyDaysOfWeek":0,"WeeklyDaysOfWeekGreaterThanOrEqualTo":0,"WeeklyDaysOfWeekGreaterThan":0,"WeeklyDaysOfWeekLessThan":0,"WeeklyDaysOfWeekLessThanOrEqualTo":0,"WeeklyDaysOfWeekNotEqualTo":0,"WeeklyDaysOfWeekBetween":"AA==","WeeklyDaysOfWeekIn":"AA==","MonthlyFrequencyType":0,"MonthlyFrequencyTypeGreaterThanOrEqualTo":0,"MonthlyFrequencyTypeGreaterThan":0,"MonthlyFrequencyTypeLessThan":0,"MonthlyFrequencyTypeLessThanOrEqualTo":0,"MonthlyFrequencyTypeNotEqualTo":0,"MonthlyFrequencyTypeBetween":"AA==","MonthlyFrequencyTypeIn":"AA==","MonthlyDayOfMonth":0,"MonthlyDayOfMonthGreaterThanOrEqualTo":0,"MonthlyDayOfMonthGreaterThan":0,"MonthlyDayOfMonthLessThan":0,"MonthlyDayOfMonthLessThanOrEqualTo":0,"MonthlyDayOfMonthNotEqualTo":0,"MonthlyDayOfMonthBetween":"AA==","MonthlyDayOfMonthIn":"AA==","MonthlyRepeatInterval":0,"MonthlyRepeatIntervalGreaterThanOrEqualTo":0,"MonthlyRepeatIntervalGreaterThan":0,"MonthlyRepeatIntervalLessThan":0,"MonthlyRepeatIntervalLessThanOrEqualTo":0,"MonthlyRepeatIntervalNotEqualTo":0,"MonthlyRepeatIntervalBetween":[0],"MonthlyRepeatIntervalIn":[0],"MonthlyFrequencyAdjective":0,"MonthlyFrequencyAdjectiveGreaterThanOrEqualTo":0,"MonthlyFrequencyAdjectiveGreaterThan":0,"MonthlyFrequencyAdjectiveLessThan":0,"MonthlyFrequencyAdjectiveLessThanOrEqualTo":0,"MonthlyFrequencyAdjectiveNotEqualTo":0,"MonthlyFrequencyAdjectiveBetween":"AA==","MonthlyFrequencyAdjectiveIn":"AA==","MonthlyFrequencyDayOfWeek":0,"MonthlyFrequencyDayOfWeekGreaterThanOrEqualTo":0,"MonthlyFrequencyDayOfWeekGreaterThan":0,"MonthlyFrequencyDayOfWeekLessThan":0,"MonthlyFrequencyDayOfWeekLessThanOrEqualTo":0,"MonthlyFrequencyDayOfWeekNotEqualTo":0,"MonthlyFrequencyDayOfWeekBetween":"AA==","MonthlyFrequencyDayOfWeekIn":"AA==","StartDate":"0001-01-01T00:00:00.0000000","StartDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateGreaterThan":"0001-01-01T00:00:00.0000000","StartDateLessThan":"0001-01-01T00:00:00.0000000","StartDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","StartDateNotEqualTo":"0001-01-01T00:00:00.0000000","StartDateBetween":["0001-01-01T00:00:00.0000000"],"StartDateIn":["0001-01-01T00:00:00.0000000"],"HasEndDate":false,"EndDate":"0001-01-01T00:00:00.0000000","EndDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateGreaterThan":"0001-01-01T00:00:00.0000000","EndDateLessThan":"0001-01-01T00:00:00.0000000","EndDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","EndDateNotEqualTo":"0001-01-01T00:00:00.0000000","EndDateBetween":["0001-01-01T00:00:00.0000000"],"EndDateIn":["0001-01-01T00:00:00.0000000"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"LastRunDate":"0001-01-01T00:00:00.0000000","LastRunDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastRunDateGreaterThan":"0001-01-01T00:00:00.0000000","LastRunDateLessThan":"0001-01-01T00:00:00.0000000","LastRunDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastRunDateNotEqualTo":"0001-01-01T00:00:00.0000000","LastRunDateBetween":["0001-01-01T00:00:00.0000000"],"LastRunDateIn":["0001-01-01T00:00:00.0000000"],"NextRunDate":"0001-01-01T00:00:00.0000000","NextRunDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","NextRunDateGreaterThan":"0001-01-01T00:00:00.0000000","NextRunDateLessThan":"0001-01-01T00:00:00.0000000","NextRunDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","NextRunDateNotEqualTo":"0001-01-01T00:00:00.0000000","NextRunDateBetween":["0001-01-01T00:00:00.0000000"],"NextRunDateIn":["0001-01-01T00:00:00.0000000"],"RowHash":"AA==","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":[{"Name":"String","EndDate":"0001-01-01T00:00:00.0000000","LastRunDate":"0001-01-01T00:00:00.0000000","NextRunDate":"0001-01-01T00:00:00.0000000","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"}}}