JiwaAPI

<back to all web services

SY_PluginScheduleQuery

Requires Authentication
SY_PluginScheduleQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryGuid[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
IsEnabledquerybool?No
ScheduleTypequerybyte?No
ScheduleTypeGreaterThanOrEqualToquerybyte?No
ScheduleTypeGreaterThanquerybyte?No
ScheduleTypeLessThanquerybyte?No
ScheduleTypeLessThanOrEqualToquerybyte?No
ScheduleTypeNotEqualToquerybyte?No
ScheduleTypeBetweenquerybyte[]No
ScheduleTypeInquerybyte[]No
OccurrenceTypequerybyte?No
OccurrenceTypeGreaterThanOrEqualToquerybyte?No
OccurrenceTypeGreaterThanquerybyte?No
OccurrenceTypeLessThanquerybyte?No
OccurrenceTypeLessThanOrEqualToquerybyte?No
OccurrenceTypeNotEqualToquerybyte?No
OccurrenceTypeBetweenquerybyte[]No
OccurrenceTypeInquerybyte[]No
OccurrenceFrequencyIntervalqueryint?No
OccurrenceFrequencyIntervalGreaterThanOrEqualToqueryint?No
OccurrenceFrequencyIntervalGreaterThanqueryint?No
OccurrenceFrequencyIntervalLessThanqueryint?No
OccurrenceFrequencyIntervalLessThanOrEqualToqueryint?No
OccurrenceFrequencyIntervalNotEqualToqueryint?No
OccurrenceFrequencyIntervalBetweenqueryint[]No
OccurrenceFrequencyIntervalInqueryint[]No
DailyFrequencyTypequerybyte?No
DailyFrequencyTypeGreaterThanOrEqualToquerybyte?No
DailyFrequencyTypeGreaterThanquerybyte?No
DailyFrequencyTypeLessThanquerybyte?No
DailyFrequencyTypeLessThanOrEqualToquerybyte?No
DailyFrequencyTypeNotEqualToquerybyte?No
DailyFrequencyTypeBetweenquerybyte[]No
DailyFrequencyTypeInquerybyte[]No
DailyOccursOnceTimequerylong?No
DailyOccursOnceTimeGreaterThanOrEqualToquerylong?No
DailyOccursOnceTimeGreaterThanquerylong?No
DailyOccursOnceTimeLessThanquerylong?No
DailyOccursOnceTimeLessThanOrEqualToquerylong?No
DailyOccursOnceTimeNotEqualToquerylong?No
DailyOccursOnceTimeBetweenquerylong[]No
DailyOccursOnceTimeInquerylong[]No
DailyRepeatsIntervalqueryint?No
DailyRepeatsIntervalGreaterThanOrEqualToqueryint?No
DailyRepeatsIntervalGreaterThanqueryint?No
DailyRepeatsIntervalLessThanqueryint?No
DailyRepeatsIntervalLessThanOrEqualToqueryint?No
DailyRepeatsIntervalNotEqualToqueryint?No
DailyRepeatsIntervalBetweenqueryint[]No
DailyRepeatsIntervalInqueryint[]No
DailyRepeatsStartTimequerylong?No
DailyRepeatsStartTimeGreaterThanOrEqualToquerylong?No
DailyRepeatsStartTimeGreaterThanquerylong?No
DailyRepeatsStartTimeLessThanquerylong?No
DailyRepeatsStartTimeLessThanOrEqualToquerylong?No
DailyRepeatsStartTimeNotEqualToquerylong?No
DailyRepeatsStartTimeBetweenquerylong[]No
DailyRepeatsStartTimeInquerylong[]No
DailyRepeatsEndTimequerylong?No
DailyRepeatsEndTimeGreaterThanOrEqualToquerylong?No
DailyRepeatsEndTimeGreaterThanquerylong?No
DailyRepeatsEndTimeLessThanquerylong?No
DailyRepeatsEndTimeLessThanOrEqualToquerylong?No
DailyRepeatsEndTimeNotEqualToquerylong?No
DailyRepeatsEndTimeBetweenquerylong[]No
DailyRepeatsEndTimeInquerylong[]No
WeeklyRepeatsIntervalqueryint?No
WeeklyRepeatsIntervalGreaterThanOrEqualToqueryint?No
WeeklyRepeatsIntervalGreaterThanqueryint?No
WeeklyRepeatsIntervalLessThanqueryint?No
WeeklyRepeatsIntervalLessThanOrEqualToqueryint?No
WeeklyRepeatsIntervalNotEqualToqueryint?No
WeeklyRepeatsIntervalBetweenqueryint[]No
WeeklyRepeatsIntervalInqueryint[]No
WeeklyDaysOfWeekquerybyte?No
WeeklyDaysOfWeekGreaterThanOrEqualToquerybyte?No
WeeklyDaysOfWeekGreaterThanquerybyte?No
WeeklyDaysOfWeekLessThanquerybyte?No
WeeklyDaysOfWeekLessThanOrEqualToquerybyte?No
WeeklyDaysOfWeekNotEqualToquerybyte?No
WeeklyDaysOfWeekBetweenquerybyte[]No
WeeklyDaysOfWeekInquerybyte[]No
MonthlyFrequencyTypequerybyte?No
MonthlyFrequencyTypeGreaterThanOrEqualToquerybyte?No
MonthlyFrequencyTypeGreaterThanquerybyte?No
MonthlyFrequencyTypeLessThanquerybyte?No
MonthlyFrequencyTypeLessThanOrEqualToquerybyte?No
MonthlyFrequencyTypeNotEqualToquerybyte?No
MonthlyFrequencyTypeBetweenquerybyte[]No
MonthlyFrequencyTypeInquerybyte[]No
MonthlyDayOfMonthquerybyte?No
MonthlyDayOfMonthGreaterThanOrEqualToquerybyte?No
MonthlyDayOfMonthGreaterThanquerybyte?No
MonthlyDayOfMonthLessThanquerybyte?No
MonthlyDayOfMonthLessThanOrEqualToquerybyte?No
MonthlyDayOfMonthNotEqualToquerybyte?No
MonthlyDayOfMonthBetweenquerybyte[]No
MonthlyDayOfMonthInquerybyte[]No
MonthlyRepeatIntervalqueryint?No
MonthlyRepeatIntervalGreaterThanOrEqualToqueryint?No
MonthlyRepeatIntervalGreaterThanqueryint?No
MonthlyRepeatIntervalLessThanqueryint?No
MonthlyRepeatIntervalLessThanOrEqualToqueryint?No
MonthlyRepeatIntervalNotEqualToqueryint?No
MonthlyRepeatIntervalBetweenqueryint[]No
MonthlyRepeatIntervalInqueryint[]No
MonthlyFrequencyAdjectivequerybyte?No
MonthlyFrequencyAdjectiveGreaterThanOrEqualToquerybyte?No
MonthlyFrequencyAdjectiveGreaterThanquerybyte?No
MonthlyFrequencyAdjectiveLessThanquerybyte?No
MonthlyFrequencyAdjectiveLessThanOrEqualToquerybyte?No
MonthlyFrequencyAdjectiveNotEqualToquerybyte?No
MonthlyFrequencyAdjectiveBetweenquerybyte[]No
MonthlyFrequencyAdjectiveInquerybyte[]No
MonthlyFrequencyDayOfWeekquerybyte?No
MonthlyFrequencyDayOfWeekGreaterThanOrEqualToquerybyte?No
MonthlyFrequencyDayOfWeekGreaterThanquerybyte?No
MonthlyFrequencyDayOfWeekLessThanquerybyte?No
MonthlyFrequencyDayOfWeekLessThanOrEqualToquerybyte?No
MonthlyFrequencyDayOfWeekNotEqualToquerybyte?No
MonthlyFrequencyDayOfWeekBetweenquerybyte[]No
MonthlyFrequencyDayOfWeekInquerybyte[]No
StartDatequeryDateTime?No
StartDateGreaterThanOrEqualToqueryDateTime?No
StartDateGreaterThanqueryDateTime?No
StartDateLessThanqueryDateTime?No
StartDateLessThanOrEqualToqueryDateTime?No
StartDateNotEqualToqueryDateTime?No
StartDateBetweenqueryDateTime[]No
StartDateInqueryDateTime[]No
HasEndDatequerybool?No
EndDatequeryDateTime?No
EndDateGreaterThanOrEqualToqueryDateTime?No
EndDateGreaterThanqueryDateTime?No
EndDateLessThanqueryDateTime?No
EndDateLessThanOrEqualToqueryDateTime?No
EndDateNotEqualToqueryDateTime?No
EndDateBetweenqueryNullable<DateTime>[]No
EndDateInqueryNullable<DateTime>[]No
ItemNoqueryshort?No
ItemNoGreaterThanOrEqualToqueryshort?No
ItemNoGreaterThanqueryshort?No
ItemNoLessThanqueryshort?No
ItemNoLessThanOrEqualToqueryshort?No
ItemNoNotEqualToqueryshort?No
ItemNoBetweenqueryshort[]No
ItemNoInqueryshort[]No
LastRunDatequeryDateTime?No
LastRunDateGreaterThanOrEqualToqueryDateTime?No
LastRunDateGreaterThanqueryDateTime?No
LastRunDateLessThanqueryDateTime?No
LastRunDateLessThanOrEqualToqueryDateTime?No
LastRunDateNotEqualToqueryDateTime?No
LastRunDateBetweenqueryNullable<DateTime>[]No
LastRunDateInqueryNullable<DateTime>[]No
NextRunDatequeryDateTime?No
NextRunDateGreaterThanOrEqualToqueryDateTime?No
NextRunDateGreaterThanqueryDateTime?No
NextRunDateLessThanqueryDateTime?No
NextRunDateLessThanOrEqualToqueryDateTime?No
NextRunDateNotEqualToqueryDateTime?No
NextRunDateBetweenqueryNullable<DateTime>[]No
NextRunDateInqueryNullable<DateTime>[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginSchedule Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
SY_Plugin_RecIDformGuidNo
NameformstringNo
IsEnabledformboolNo
ScheduleTypeformbyteNo
OccurrenceTypeformbyteNo
OccurrenceFrequencyIntervalformintNo
DailyFrequencyTypeformbyteNo
DailyOccursOnceTimeformlongNo
DailyRepeatsIntervalformintNo
DailyRepeatsStartTimeformlongNo
DailyRepeatsEndTimeformlongNo
WeeklyRepeatsIntervalformintNo
WeeklyDaysOfWeekformbyteNo
MonthlyFrequencyTypeformbyteNo
MonthlyDayOfMonthformbyteNo
MonthlyRepeatIntervalformintNo
MonthlyFrequencyAdjectiveformbyteNo
MonthlyFrequencyDayOfWeekformbyteNo
StartDateformDateTimeNo
HasEndDateformboolNo
EndDateformDateTime?No
ItemNoformshortNo
LastRunDateformDateTime?No
NextRunDateformDateTime?No
RowHashformbyte[]No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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

HTTP + JSON

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"}}}