JiwaAPI

<back to all web services

SY_MenuItemQuery

Requires Authentication
SY_MenuItemQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SY_Menu_RecIDquerystringNo
SY_Menu_RecIDStartsWithquerystringNo
SY_Menu_RecIDEndsWithquerystringNo
SY_Menu_RecIDContainsquerystringNo
SY_Menu_RecIDLikequerystringNo
SY_Menu_RecIDBetweenquerystring[]No
SY_Menu_RecIDInquerystring[]No
Typequerybyte?No
TypeGreaterThanOrEqualToquerybyte?No
TypeGreaterThanquerybyte?No
TypeLessThanquerybyte?No
TypeLessThanOrEqualToquerybyte?No
TypeNotEqualToquerybyte?No
TypeBetweenquerybyte[]No
TypeInquerybyte[]No
CaptionquerystringNo
CaptionStartsWithquerystringNo
CaptionEndsWithquerystringNo
CaptionContainsquerystringNo
CaptionLikequerystringNo
CaptionBetweenquerystring[]No
CaptionInquerystring[]No
SY_MenuItem_RecIDquerystringNo
SY_MenuItem_RecIDStartsWithquerystringNo
SY_MenuItem_RecIDEndsWithquerystringNo
SY_MenuItem_RecIDContainsquerystringNo
SY_MenuItem_RecIDLikequerystringNo
SY_MenuItem_RecIDBetweenquerystring[]No
SY_MenuItem_RecIDInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
RowHashquerybyte[]No
SY_Image_RecIDqueryGuid?No
SY_Image_RecIDInqueryNullable<Guid>[]No
SY_Image_RecID_SelectedqueryGuid?No
SY_Image_RecID_SelectedInqueryNullable<Guid>[]No
SY_Image_RecID_HotTrackedqueryGuid?No
SY_Image_RecID_HotTrackedInqueryNullable<Guid>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_MenuItem Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SY_Menu_RecIDformstringNo
TypeformbyteNo
CaptionformstringNo
SY_MenuItem_RecIDformstringNo
ItemNoformintNo
LastSavedDateTimeformDateTimeNo
RowHashformbyte[]No
SY_Image_RecIDformGuid?No
SY_Image_RecID_SelectedformGuid?No
SY_Image_RecID_HotTrackedformGuid?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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/SY_MenuItemQuery 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"],"SY_Menu_RecID":"String","SY_Menu_RecIDStartsWith":"String","SY_Menu_RecIDEndsWith":"String","SY_Menu_RecIDContains":"String","SY_Menu_RecIDLike":"String","SY_Menu_RecIDBetween":["String"],"SY_Menu_RecIDIn":["String"],"Type":0,"TypeGreaterThanOrEqualTo":0,"TypeGreaterThan":0,"TypeLessThan":0,"TypeLessThanOrEqualTo":0,"TypeNotEqualTo":0,"TypeBetween":"AA==","TypeIn":"AA==","Caption":"String","CaptionStartsWith":"String","CaptionEndsWith":"String","CaptionContains":"String","CaptionLike":"String","CaptionBetween":["String"],"CaptionIn":["String"],"SY_MenuItem_RecID":"String","SY_MenuItem_RecIDStartsWith":"String","SY_MenuItem_RecIDEndsWith":"String","SY_MenuItem_RecIDContains":"String","SY_MenuItem_RecIDLike":"String","SY_MenuItem_RecIDBetween":["String"],"SY_MenuItem_RecIDIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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==","SY_Image_RecID":"00000000000000000000000000000000","SY_Image_RecIDIn":["00000000000000000000000000000000"],"SY_Image_RecID_Selected":"00000000000000000000000000000000","SY_Image_RecID_SelectedIn":["00000000000000000000000000000000"],"SY_Image_RecID_HotTracked":"00000000000000000000000000000000","SY_Image_RecID_HotTrackedIn":["00000000000000000000000000000000"],"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","SY_Menu_RecID":"String","Caption":"String","SY_MenuItem_RecID":"String","RowHash":"AA==","SY_Image_RecID":"00000000000000000000000000000000","SY_Image_RecID_Selected":"00000000000000000000000000000000","SY_Image_RecID_HotTracked":"00000000000000000000000000000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}