JiwaAPI

<back to all web services

TD_MainQuery

Requires Authentication
TD_MainQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
ToDoNoquerystringNo
ToDoNoStartsWithquerystringNo
ToDoNoEndsWithquerystringNo
ToDoNoContainsquerystringNo
ToDoNoLikequerystringNo
ToDoNoBetweenquerystring[]No
ToDoNoInquerystring[]No
SubjectquerystringNo
SubjectStartsWithquerystringNo
SubjectEndsWithquerystringNo
SubjectContainsquerystringNo
SubjectLikequerystringNo
SubjectBetweenquerystring[]No
SubjectInquerystring[]No
BodyquerystringNo
BodyStartsWithquerystringNo
BodyEndsWithquerystringNo
BodyContainsquerystringNo
BodyLikequerystringNo
BodyBetweenquerystring[]No
BodyInquerystring[]No
TD_Priorities_RecIDquerystringNo
TD_Priorities_RecIDStartsWithquerystringNo
TD_Priorities_RecIDEndsWithquerystringNo
TD_Priorities_RecIDContainsquerystringNo
TD_Priorities_RecIDLikequerystringNo
TD_Priorities_RecIDBetweenquerystring[]No
TD_Priorities_RecIDInquerystring[]No
DurationInHoursqueryint?No
DurationInHoursGreaterThanOrEqualToqueryint?No
DurationInHoursGreaterThanqueryint?No
DurationInHoursLessThanqueryint?No
DurationInHoursLessThanOrEqualToqueryint?No
DurationInHoursNotEqualToqueryint?No
DurationInHoursBetweenqueryint[]No
DurationInHoursInqueryint[]No
AssignedBy_HR_Staff_RecIDquerystringNo
AssignedBy_HR_Staff_RecIDStartsWithquerystringNo
AssignedBy_HR_Staff_RecIDEndsWithquerystringNo
AssignedBy_HR_Staff_RecIDContainsquerystringNo
AssignedBy_HR_Staff_RecIDLikequerystringNo
AssignedBy_HR_Staff_RecIDBetweenquerystring[]No
AssignedBy_HR_Staff_RecIDInquerystring[]No
AssignedTo_HR_Staff_RecIDquerystringNo
AssignedTo_HR_Staff_RecIDStartsWithquerystringNo
AssignedTo_HR_Staff_RecIDEndsWithquerystringNo
AssignedTo_HR_Staff_RecIDContainsquerystringNo
AssignedTo_HR_Staff_RecIDLikequerystringNo
AssignedTo_HR_Staff_RecIDBetweenquerystring[]No
AssignedTo_HR_Staff_RecIDInquerystring[]No
ReminderEnabledquerybool?No
ReminderTriggerqueryint?No
ReminderTriggerGreaterThanOrEqualToqueryint?No
ReminderTriggerGreaterThanqueryint?No
ReminderTriggerLessThanqueryint?No
ReminderTriggerLessThanOrEqualToqueryint?No
ReminderTriggerNotEqualToqueryint?No
ReminderTriggerBetweenqueryint[]No
ReminderTriggerInqueryint[]No
ReminderPredefinedSettingqueryint?No
ReminderPredefinedSettingGreaterThanOrEqualToqueryint?No
ReminderPredefinedSettingGreaterThanqueryint?No
ReminderPredefinedSettingLessThanqueryint?No
ReminderPredefinedSettingLessThanOrEqualToqueryint?No
ReminderPredefinedSettingNotEqualToqueryint?No
ReminderPredefinedSettingBetweenqueryint[]No
ReminderPredefinedSettingInqueryint[]No
ReminderSpecificDateTimequeryDateTime?No
ReminderSpecificDateTimeGreaterThanOrEqualToqueryDateTime?No
ReminderSpecificDateTimeGreaterThanqueryDateTime?No
ReminderSpecificDateTimeLessThanqueryDateTime?No
ReminderSpecificDateTimeLessThanOrEqualToqueryDateTime?No
ReminderSpecificDateTimeNotEqualToqueryDateTime?No
ReminderSpecificDateTimeBetweenqueryDateTime[]No
ReminderSpecificDateTimeInqueryDateTime[]No
Source_SY_Forms_ClassNamequerystringNo
Source_SY_Forms_ClassNameStartsWithquerystringNo
Source_SY_Forms_ClassNameEndsWithquerystringNo
Source_SY_Forms_ClassNameContainsquerystringNo
Source_SY_Forms_ClassNameLikequerystringNo
Source_SY_Forms_ClassNameBetweenquerystring[]No
Source_SY_Forms_ClassNameInquerystring[]No
Source_RecIDquerystringNo
Source_RecIDStartsWithquerystringNo
Source_RecIDEndsWithquerystringNo
Source_RecIDContainsquerystringNo
Source_RecIDLikequerystringNo
Source_RecIDBetweenquerystring[]No
Source_RecIDInquerystring[]No
TD_ToDoTypes_RecIDquerystringNo
TD_ToDoTypes_RecIDStartsWithquerystringNo
TD_ToDoTypes_RecIDEndsWithquerystringNo
TD_ToDoTypes_RecIDContainsquerystringNo
TD_ToDoTypes_RecIDLikequerystringNo
TD_ToDoTypes_RecIDBetweenquerystring[]No
TD_ToDoTypes_RecIDInquerystring[]No
UsesStatusTrackingquerybool?No
TD_Statuses_RecIDquerystringNo
TD_Statuses_RecIDStartsWithquerystringNo
TD_Statuses_RecIDEndsWithquerystringNo
TD_Statuses_RecIDContainsquerystringNo
TD_Statuses_RecIDLikequerystringNo
TD_Statuses_RecIDBetweenquerystring[]No
TD_Statuses_RecIDInquerystring[]No
CompletePercentagequeryint?No
CompletePercentageGreaterThanOrEqualToqueryint?No
CompletePercentageGreaterThanqueryint?No
CompletePercentageLessThanqueryint?No
CompletePercentageLessThanOrEqualToqueryint?No
CompletePercentageNotEqualToqueryint?No
CompletePercentageBetweenqueryint[]No
CompletePercentageInqueryint[]No
LastSaved_HR_Staff_RecIDquerystringNo
LastSaved_HR_Staff_RecIDStartsWithquerystringNo
LastSaved_HR_Staff_RecIDEndsWithquerystringNo
LastSaved_HR_Staff_RecIDContainsquerystringNo
LastSaved_HR_Staff_RecIDLikequerystringNo
LastSaved_HR_Staff_RecIDBetweenquerystring[]No
LastSaved_HR_Staff_RecIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DueDateTimequeryDateTime?No
DueDateTimeGreaterThanOrEqualToqueryDateTime?No
DueDateTimeGreaterThanqueryDateTime?No
DueDateTimeLessThanqueryDateTime?No
DueDateTimeLessThanOrEqualToqueryDateTime?No
DueDateTimeNotEqualToqueryDateTime?No
DueDateTimeBetweenqueryDateTime[]No
DueDateTimeInqueryDateTime[]No
FinishedDateTimequeryDateTime?No
FinishedDateTimeGreaterThanOrEqualToqueryDateTime?No
FinishedDateTimeGreaterThanqueryDateTime?No
FinishedDateTimeLessThanqueryDateTime?No
FinishedDateTimeLessThanOrEqualToqueryDateTime?No
FinishedDateTimeNotEqualToqueryDateTime?No
FinishedDateTimeBetweenqueryNullable<DateTime>[]No
FinishedDateTimeInqueryNullable<DateTime>[]No
HasBeenReadquerybool?No
ReminderSentquerybool?No
Source_DisplayTextquerystringNo
Source_DisplayTextStartsWithquerystringNo
Source_DisplayTextEndsWithquerystringNo
Source_DisplayTextContainsquerystringNo
Source_DisplayTextLikequerystringNo
Source_DisplayTextBetweenquerystring[]No
Source_DisplayTextInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
TD_Main Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ToDoNoformstringNo
SubjectformstringNo
BodyformstringNo
TD_Priorities_RecIDformstringNo
DurationInHoursformintNo
AssignedBy_HR_Staff_RecIDformstringNo
AssignedTo_HR_Staff_RecIDformstringNo
ReminderEnabledformboolNo
ReminderTriggerformintNo
ReminderPredefinedSettingformintNo
ReminderSpecificDateTimeformDateTimeNo
Source_SY_Forms_ClassNameformstringNo
Source_RecIDformstringNo
TD_ToDoTypes_RecIDformstringNo
UsesStatusTrackingformboolNo
TD_Statuses_RecIDformstringNo
CompletePercentageformintNo
LastSaved_HR_Staff_RecIDformstringNo
LastSavedDateTimeformDateTimeNo
DueDateTimeformDateTimeNo
FinishedDateTimeformDateTime?No
HasBeenReadformboolNo
ReminderSentformboolNo
Source_DisplayTextformstringNo
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/TD_MainQuery 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"],"ToDoNo":"String","ToDoNoStartsWith":"String","ToDoNoEndsWith":"String","ToDoNoContains":"String","ToDoNoLike":"String","ToDoNoBetween":["String"],"ToDoNoIn":["String"],"Subject":"String","SubjectStartsWith":"String","SubjectEndsWith":"String","SubjectContains":"String","SubjectLike":"String","SubjectBetween":["String"],"SubjectIn":["String"],"Body":"String","BodyStartsWith":"String","BodyEndsWith":"String","BodyContains":"String","BodyLike":"String","BodyBetween":["String"],"BodyIn":["String"],"TD_Priorities_RecID":"String","TD_Priorities_RecIDStartsWith":"String","TD_Priorities_RecIDEndsWith":"String","TD_Priorities_RecIDContains":"String","TD_Priorities_RecIDLike":"String","TD_Priorities_RecIDBetween":["String"],"TD_Priorities_RecIDIn":["String"],"DurationInHours":0,"DurationInHoursGreaterThanOrEqualTo":0,"DurationInHoursGreaterThan":0,"DurationInHoursLessThan":0,"DurationInHoursLessThanOrEqualTo":0,"DurationInHoursNotEqualTo":0,"DurationInHoursBetween":[0],"DurationInHoursIn":[0],"AssignedBy_HR_Staff_RecID":"String","AssignedBy_HR_Staff_RecIDStartsWith":"String","AssignedBy_HR_Staff_RecIDEndsWith":"String","AssignedBy_HR_Staff_RecIDContains":"String","AssignedBy_HR_Staff_RecIDLike":"String","AssignedBy_HR_Staff_RecIDBetween":["String"],"AssignedBy_HR_Staff_RecIDIn":["String"],"AssignedTo_HR_Staff_RecID":"String","AssignedTo_HR_Staff_RecIDStartsWith":"String","AssignedTo_HR_Staff_RecIDEndsWith":"String","AssignedTo_HR_Staff_RecIDContains":"String","AssignedTo_HR_Staff_RecIDLike":"String","AssignedTo_HR_Staff_RecIDBetween":["String"],"AssignedTo_HR_Staff_RecIDIn":["String"],"ReminderEnabled":false,"ReminderTrigger":0,"ReminderTriggerGreaterThanOrEqualTo":0,"ReminderTriggerGreaterThan":0,"ReminderTriggerLessThan":0,"ReminderTriggerLessThanOrEqualTo":0,"ReminderTriggerNotEqualTo":0,"ReminderTriggerBetween":[0],"ReminderTriggerIn":[0],"ReminderPredefinedSetting":0,"ReminderPredefinedSettingGreaterThanOrEqualTo":0,"ReminderPredefinedSettingGreaterThan":0,"ReminderPredefinedSettingLessThan":0,"ReminderPredefinedSettingLessThanOrEqualTo":0,"ReminderPredefinedSettingNotEqualTo":0,"ReminderPredefinedSettingBetween":[0],"ReminderPredefinedSettingIn":[0],"ReminderSpecificDateTime":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeLessThan":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","ReminderSpecificDateTimeBetween":["0001-01-01T00:00:00.0000000"],"ReminderSpecificDateTimeIn":["0001-01-01T00:00:00.0000000"],"Source_SY_Forms_ClassName":"String","Source_SY_Forms_ClassNameStartsWith":"String","Source_SY_Forms_ClassNameEndsWith":"String","Source_SY_Forms_ClassNameContains":"String","Source_SY_Forms_ClassNameLike":"String","Source_SY_Forms_ClassNameBetween":["String"],"Source_SY_Forms_ClassNameIn":["String"],"Source_RecID":"String","Source_RecIDStartsWith":"String","Source_RecIDEndsWith":"String","Source_RecIDContains":"String","Source_RecIDLike":"String","Source_RecIDBetween":["String"],"Source_RecIDIn":["String"],"TD_ToDoTypes_RecID":"String","TD_ToDoTypes_RecIDStartsWith":"String","TD_ToDoTypes_RecIDEndsWith":"String","TD_ToDoTypes_RecIDContains":"String","TD_ToDoTypes_RecIDLike":"String","TD_ToDoTypes_RecIDBetween":["String"],"TD_ToDoTypes_RecIDIn":["String"],"UsesStatusTracking":false,"TD_Statuses_RecID":"String","TD_Statuses_RecIDStartsWith":"String","TD_Statuses_RecIDEndsWith":"String","TD_Statuses_RecIDContains":"String","TD_Statuses_RecIDLike":"String","TD_Statuses_RecIDBetween":["String"],"TD_Statuses_RecIDIn":["String"],"CompletePercentage":0,"CompletePercentageGreaterThanOrEqualTo":0,"CompletePercentageGreaterThan":0,"CompletePercentageLessThan":0,"CompletePercentageLessThanOrEqualTo":0,"CompletePercentageNotEqualTo":0,"CompletePercentageBetween":[0],"CompletePercentageIn":[0],"LastSaved_HR_Staff_RecID":"String","LastSaved_HR_Staff_RecIDStartsWith":"String","LastSaved_HR_Staff_RecIDEndsWith":"String","LastSaved_HR_Staff_RecIDContains":"String","LastSaved_HR_Staff_RecIDLike":"String","LastSaved_HR_Staff_RecIDBetween":["String"],"LastSaved_HR_Staff_RecIDIn":["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"],"DueDateTime":"0001-01-01T00:00:00.0000000","DueDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","DueDateTimeLessThan":"0001-01-01T00:00:00.0000000","DueDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateTimeBetween":["0001-01-01T00:00:00.0000000"],"DueDateTimeIn":["0001-01-01T00:00:00.0000000"],"FinishedDateTime":"0001-01-01T00:00:00.0000000","FinishedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","FinishedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","FinishedDateTimeLessThan":"0001-01-01T00:00:00.0000000","FinishedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","FinishedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","FinishedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"FinishedDateTimeIn":["0001-01-01T00:00:00.0000000"],"HasBeenRead":false,"ReminderSent":false,"Source_DisplayText":"String","Source_DisplayTextStartsWith":"String","Source_DisplayTextEndsWith":"String","Source_DisplayTextContains":"String","Source_DisplayTextLike":"String","Source_DisplayTextBetween":["String"],"Source_DisplayTextIn":["String"],"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","ToDoNo":"String","Subject":"String","Body":"String","TD_Priorities_RecID":"String","AssignedBy_HR_Staff_RecID":"String","AssignedTo_HR_Staff_RecID":"String","Source_SY_Forms_ClassName":"String","Source_RecID":"String","TD_ToDoTypes_RecID":"String","TD_Statuses_RecID":"String","LastSaved_HR_Staff_RecID":"String","FinishedDateTime":"0001-01-01T00:00:00.0000000","Source_DisplayText":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}