JiwaAPI

<back to all web services

SY_FormSettingsQuery

Requires Authentication
SY_FormSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SY_Forms_ClassNamequerystringNo
SY_Forms_ClassNameStartsWithquerystringNo
SY_Forms_ClassNameEndsWithquerystringNo
SY_Forms_ClassNameContainsquerystringNo
SY_Forms_ClassNameLikequerystringNo
SY_Forms_ClassNameBetweenquerystring[]No
SY_Forms_ClassNameInquerystring[]No
HR_Staff_RecIDquerystringNo
HR_Staff_RecIDStartsWithquerystringNo
HR_Staff_RecIDEndsWithquerystringNo
HR_Staff_RecIDContainsquerystringNo
HR_Staff_RecIDLikequerystringNo
HR_Staff_RecIDBetweenquerystring[]No
HR_Staff_RecIDInquerystring[]No
WindowStatequerybyte?No
WindowStateGreaterThanOrEqualToquerybyte?No
WindowStateGreaterThanquerybyte?No
WindowStateLessThanquerybyte?No
WindowStateLessThanOrEqualToquerybyte?No
WindowStateNotEqualToquerybyte?No
WindowStateBetweenquerybyte[]No
WindowStateInquerybyte[]No
Topqueryint?No
TopGreaterThanOrEqualToqueryint?No
TopGreaterThanqueryint?No
TopLessThanqueryint?No
TopLessThanOrEqualToqueryint?No
TopNotEqualToqueryint?No
TopBetweenqueryint[]No
TopInqueryint[]No
Leftqueryint?No
LeftGreaterThanOrEqualToqueryint?No
LeftGreaterThanqueryint?No
LeftLessThanqueryint?No
LeftLessThanOrEqualToqueryint?No
LeftNotEqualToqueryint?No
LeftBetweenqueryint[]No
LeftInqueryint[]No
Widthqueryint?No
WidthGreaterThanOrEqualToqueryint?No
WidthGreaterThanqueryint?No
WidthLessThanqueryint?No
WidthLessThanOrEqualToqueryint?No
WidthNotEqualToqueryint?No
WidthBetweenqueryint[]No
WidthInqueryint[]No
Heightqueryint?No
HeightGreaterThanOrEqualToqueryint?No
HeightGreaterThanqueryint?No
HeightLessThanqueryint?No
HeightLessThanOrEqualToqueryint?No
HeightNotEqualToqueryint?No
HeightBetweenqueryint[]No
HeightInqueryint[]No
ContextquerystringNo
ContextStartsWithquerystringNo
ContextEndsWithquerystringNo
ContextContainsquerystringNo
ContextLikequerystringNo
ContextBetweenquerystring[]No
ContextInquerystring[]No
Floatingquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_FormSettings Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SY_Forms_ClassNameformstringNo
HR_Staff_RecIDformstringNo
WindowStateformbyteNo
TopformintNo
LeftformintNo
WidthformintNo
HeightformintNo
ContextformstringNo
Floatingformbool?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_FormSettingsQuery 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_Forms_ClassName":"String","SY_Forms_ClassNameStartsWith":"String","SY_Forms_ClassNameEndsWith":"String","SY_Forms_ClassNameContains":"String","SY_Forms_ClassNameLike":"String","SY_Forms_ClassNameBetween":["String"],"SY_Forms_ClassNameIn":["String"],"HR_Staff_RecID":"String","HR_Staff_RecIDStartsWith":"String","HR_Staff_RecIDEndsWith":"String","HR_Staff_RecIDContains":"String","HR_Staff_RecIDLike":"String","HR_Staff_RecIDBetween":["String"],"HR_Staff_RecIDIn":["String"],"WindowState":0,"WindowStateGreaterThanOrEqualTo":0,"WindowStateGreaterThan":0,"WindowStateLessThan":0,"WindowStateLessThanOrEqualTo":0,"WindowStateNotEqualTo":0,"WindowStateBetween":"AA==","WindowStateIn":"AA==","Top":0,"TopGreaterThanOrEqualTo":0,"TopGreaterThan":0,"TopLessThan":0,"TopLessThanOrEqualTo":0,"TopNotEqualTo":0,"TopBetween":[0],"TopIn":[0],"Left":0,"LeftGreaterThanOrEqualTo":0,"LeftGreaterThan":0,"LeftLessThan":0,"LeftLessThanOrEqualTo":0,"LeftNotEqualTo":0,"LeftBetween":[0],"LeftIn":[0],"Width":0,"WidthGreaterThanOrEqualTo":0,"WidthGreaterThan":0,"WidthLessThan":0,"WidthLessThanOrEqualTo":0,"WidthNotEqualTo":0,"WidthBetween":[0],"WidthIn":[0],"Height":0,"HeightGreaterThanOrEqualTo":0,"HeightGreaterThan":0,"HeightLessThan":0,"HeightLessThanOrEqualTo":0,"HeightNotEqualTo":0,"HeightBetween":[0],"HeightIn":[0],"Context":"String","ContextStartsWith":"String","ContextEndsWith":"String","ContextContains":"String","ContextLike":"String","ContextBetween":["String"],"ContextIn":["String"],"Floating":false,"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_Forms_ClassName":"String","HR_Staff_RecID":"String","Context":"String","Floating":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}