JiwaAPI

<back to all web services

BM_InputCustomFieldsQuery

Requires Authentication
BM_InputCustomFieldsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SettingNamequerystringNo
SettingNameStartsWithquerystringNo
SettingNameEndsWithquerystringNo
SettingNameContainsquerystringNo
SettingNameLikequerystringNo
SettingNameBetweenquerystring[]No
SettingNameInquerystring[]No
SettingDescriptionquerystringNo
SettingDescriptionStartsWithquerystringNo
SettingDescriptionEndsWithquerystringNo
SettingDescriptionContainsquerystringNo
SettingDescriptionLikequerystringNo
SettingDescriptionBetweenquerystring[]No
SettingDescriptionInquerystring[]No
CellTypequeryint?No
CellTypeGreaterThanOrEqualToqueryint?No
CellTypeGreaterThanqueryint?No
CellTypeLessThanqueryint?No
CellTypeLessThanOrEqualToqueryint?No
CellTypeNotEqualToqueryint?No
CellTypeBetweenqueryNullable<Int32>[]No
CellTypeInqueryNullable<Int32>[]No
FieldParameterquerystringNo
FieldParameterStartsWithquerystringNo
FieldParameterEndsWithquerystringNo
FieldParameterContainsquerystringNo
FieldParameterLikequerystringNo
FieldParameterBetweenquerystring[]No
FieldParameterInquerystring[]No
SY_Plugin_RecIDqueryGuid?No
SY_Plugin_RecIDInqueryGuid[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DisplayOrderqueryint?No
DisplayOrderGreaterThanOrEqualToqueryint?No
DisplayOrderGreaterThanqueryint?No
DisplayOrderLessThanqueryint?No
DisplayOrderLessThanOrEqualToqueryint?No
DisplayOrderNotEqualToqueryint?No
DisplayOrderBetweenqueryNullable<Int32>[]No
DisplayOrderInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BM_InputCustomFields Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SettingNameformstringNo
SettingDescriptionformstringNo
CellTypeformint?No
FieldParameterformstringNo
SY_Plugin_RecIDformGuidNo
LastSavedDateTimeformDateTimeNo
DisplayOrderformint?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/BM_InputCustomFieldsQuery 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"],"SettingName":"String","SettingNameStartsWith":"String","SettingNameEndsWith":"String","SettingNameContains":"String","SettingNameLike":"String","SettingNameBetween":["String"],"SettingNameIn":["String"],"SettingDescription":"String","SettingDescriptionStartsWith":"String","SettingDescriptionEndsWith":"String","SettingDescriptionContains":"String","SettingDescriptionLike":"String","SettingDescriptionBetween":["String"],"SettingDescriptionIn":["String"],"CellType":0,"CellTypeGreaterThanOrEqualTo":0,"CellTypeGreaterThan":0,"CellTypeLessThan":0,"CellTypeLessThanOrEqualTo":0,"CellTypeNotEqualTo":0,"CellTypeBetween":[0],"CellTypeIn":[0],"FieldParameter":"String","FieldParameterStartsWith":"String","FieldParameterEndsWith":"String","FieldParameterContains":"String","FieldParameterLike":"String","FieldParameterBetween":["String"],"FieldParameterIn":["String"],"SY_Plugin_RecID":"00000000000000000000000000000000","SY_Plugin_RecIDIn":["00000000-0000-0000-0000-000000000000"],"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"],"DisplayOrder":0,"DisplayOrderGreaterThanOrEqualTo":0,"DisplayOrderGreaterThan":0,"DisplayOrderLessThan":0,"DisplayOrderLessThanOrEqualTo":0,"DisplayOrderNotEqualTo":0,"DisplayOrderBetween":[0],"DisplayOrderIn":[0],"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","SettingName":"String","SettingDescription":"String","CellType":0,"FieldParameter":"String","DisplayOrder":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}