JiwaAPI

<back to all web services

SY_PluginCustomSettingModulesQuery

Requires Authentication
SY_PluginCustomSettingModulesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDqueryGuid?No
RecIDInqueryGuid[]No
ModuleNamequerystringNo
ModuleNameStartsWithquerystringNo
ModuleNameEndsWithquerystringNo
ModuleNameContainsquerystringNo
ModuleNameLikequerystringNo
ModuleNameBetweenquerystring[]No
ModuleNameInquerystring[]No
TableNamequerystringNo
TableNameStartsWithquerystringNo
TableNameEndsWithquerystringNo
TableNameContainsquerystringNo
TableNameLikequerystringNo
TableNameBetweenquerystring[]No
TableNameInquerystring[]No
IDColumnNamequerystringNo
IDColumnNameStartsWithquerystringNo
IDColumnNameEndsWithquerystringNo
IDColumnNameContainsquerystringNo
IDColumnNameLikequerystringNo
IDColumnNameBetweenquerystring[]No
IDColumnNameInquerystring[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
RowHashquerybyte[]No
ValuesTableNamequerystringNo
ValuesTableNameStartsWithquerystringNo
ValuesTableNameEndsWithquerystringNo
ValuesTableNameContainsquerystringNo
ValuesTableNameLikequerystringNo
ValuesTableNameBetweenquerystring[]No
ValuesTableNameInquerystring[]No
ValuesIDColumnNamequerystringNo
ValuesIDColumnNameStartsWithquerystringNo
ValuesIDColumnNameEndsWithquerystringNo
ValuesIDColumnNameContainsquerystringNo
ValuesIDColumnNameLikequerystringNo
ValuesIDColumnNameBetweenquerystring[]No
ValuesIDColumnNameInquerystring[]No
ValuesSettingIDColumnNamequerystringNo
ValuesSettingIDColumnNameStartsWithquerystringNo
ValuesSettingIDColumnNameEndsWithquerystringNo
ValuesSettingIDColumnNameContainsquerystringNo
ValuesSettingIDColumnNameLikequerystringNo
ValuesSettingIDColumnNameBetweenquerystring[]No
ValuesSettingIDColumnNameInquerystring[]No
ValuesFKIDColumnNamequerystringNo
ValuesFKIDColumnNameStartsWithquerystringNo
ValuesFKIDColumnNameEndsWithquerystringNo
ValuesFKIDColumnNameContainsquerystringNo
ValuesFKIDColumnNameLikequerystringNo
ValuesFKIDColumnNameBetweenquerystring[]No
ValuesFKIDColumnNameInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_PluginCustomSettingModules Parameters:
NameParameterData TypeRequiredDescription
RecIDformGuidNo
ModuleNameformstringNo
TableNameformstringNo
IDColumnNameformstringNo
ItemNoformintNo
RowHashformbyte[]No
ValuesTableNameformstringNo
ValuesIDColumnNameformstringNo
ValuesSettingIDColumnNameformstringNo
ValuesFKIDColumnNameformstringNo
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_PluginCustomSettingModulesQuery 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"],"ModuleName":"String","ModuleNameStartsWith":"String","ModuleNameEndsWith":"String","ModuleNameContains":"String","ModuleNameLike":"String","ModuleNameBetween":["String"],"ModuleNameIn":["String"],"TableName":"String","TableNameStartsWith":"String","TableNameEndsWith":"String","TableNameContains":"String","TableNameLike":"String","TableNameBetween":["String"],"TableNameIn":["String"],"IDColumnName":"String","IDColumnNameStartsWith":"String","IDColumnNameEndsWith":"String","IDColumnNameContains":"String","IDColumnNameLike":"String","IDColumnNameBetween":["String"],"IDColumnNameIn":["String"],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","ValuesTableName":"String","ValuesTableNameStartsWith":"String","ValuesTableNameEndsWith":"String","ValuesTableNameContains":"String","ValuesTableNameLike":"String","ValuesTableNameBetween":["String"],"ValuesTableNameIn":["String"],"ValuesIDColumnName":"String","ValuesIDColumnNameStartsWith":"String","ValuesIDColumnNameEndsWith":"String","ValuesIDColumnNameContains":"String","ValuesIDColumnNameLike":"String","ValuesIDColumnNameBetween":["String"],"ValuesIDColumnNameIn":["String"],"ValuesSettingIDColumnName":"String","ValuesSettingIDColumnNameStartsWith":"String","ValuesSettingIDColumnNameEndsWith":"String","ValuesSettingIDColumnNameContains":"String","ValuesSettingIDColumnNameLike":"String","ValuesSettingIDColumnNameBetween":["String"],"ValuesSettingIDColumnNameIn":["String"],"ValuesFKIDColumnName":"String","ValuesFKIDColumnNameStartsWith":"String","ValuesFKIDColumnNameEndsWith":"String","ValuesFKIDColumnNameContains":"String","ValuesFKIDColumnNameLike":"String","ValuesFKIDColumnNameBetween":["String"],"ValuesFKIDColumnNameIn":["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":[{"ModuleName":"String","TableName":"String","IDColumnName":"String","RowHash":"AA==","ValuesTableName":"String","ValuesIDColumnName":"String","ValuesSettingIDColumnName":"String","ValuesFKIDColumnName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}